feedBack/.github/workflows/sync-version.yml
Miguel_LZPF e4187d0054
feat: add cross-tool orientation, CI schema validation, and Claude Code surfaces
Adds the contributor- and AI-tool-facing infrastructure on top of the
modular docs from the previous commit. Lands AGENTS.md as the canonical
cross-tool orientation (read natively by Cursor, Copilot, Codex, Aider,
Cline, Continue, Cody, Devin, Replit Agent, and Claude Code), flips
CLAUDE.md to a 22-line pointer that uses Claude Code's @-import to
inline AGENTS.md, wires up plugin.json validation in CI, and adds the
Claude-specific automation surfaces under .claude/.

Cross-tool orientation:
  AGENTS.md (178 lines) — single source of truth: architecture, running
    the app, testing, git workflow, versioning, song formats, frontend
    and backend conventions, plugin authoring index, first-hour
    pitfalls, verification, house rules.
  CLAUDE.md (22 lines) — Claude Code memory file. Uses @AGENTS.md
    import (recursion depth 5) so the canonical content is inlined
    without duplication. Lists .claude/ surfaces.
  .github/copilot-instructions.md — Copilot custom instructions
    format; points at AGENTS.md and docs/PLUGIN_AUTHORING.md.
  .cursorrules — not added. Cursor reads AGENTS.md natively in 2026
    and .cursorrules is legacy.

Contribution hygiene (.github/):
  PULL_REQUEST_TEMPLATE.md — summary, linked issue, test plan, DCO
    and conventional-commit reminders. No AI-disclosure section.
  ISSUE_TEMPLATE/bug.yml — version, deployment, OS, plugins enabled,
    repro, logs (linked to docs/diagnostics-bundle-spec.md for
    redaction guidance).
  ISSUE_TEMPLATE/feature.yml — problem, proposed, alternatives,
    surface, plugin-author impact, license check.
  ISSUE_TEMPLATE/config.yml — disables blank issues; redirects
    plugin issues to plugin repos and security to the private
    advisory flow.

CI:
  .github/workflows/validate-plugins.yml — runs on changes to
    plugins/*, schema/, CONTRIBUTING.md, the test file, or the
    workflow itself. Installs jsonschema and pytest, validates every
    plugins/*/plugin.json against schema/plugin.schema.json, and runs
    the license-allowlist subset check.
  tests/test_plugin_schema.py — 8 parametrized tests: schema is
    well-formed, the 3 in-tree manifests validate, manifest id
    matches its parent directory name, schema license enum is a
    subset of CONTRIBUTING's curated allowlist.
  requirements-test.txt — append jsonschema>=4.0.
  .github/workflows/sync-version.yml — comment retargeted to
    AGENTS.md "Versioning" section.

Claude Code surfaces (.claude/):
  README.md — layout explanation. Spec-kit owns skills/speckit-*;
    repo-specific skills sit alongside. Hooks off by default;
    settings.json carries a commented opt-in example.
  skills/plugin-scaffold/SKILL.md — generates a plugin skeleton for
    type in {visualization, overlay, settings-only, routes-only}.
  skills/plugin-validate/SKILL.md — local pre-push check: validates
    plugin.json against schema, asserts declared files exist,
    enforces license allowlist.
  rules/plugin-author.md — globs scoped to plugins/**. Encodes the
    contracts from docs/PLUGIN_AUTHORING.md so AI suggestions don't
    drift from them (manifest required, context[\"log\"] over print,
    load_sibling over bare imports, playSong await discipline,
    settings.server_files conventions).
  agents/slopsmith-reviewer.md — plugin-aware reviewer subagent;
    invoke with @slopsmith-reviewer. 12-item checklist mirrors the
    rule and the schema.
  settings.json — empty hooks block plus a commented PostToolUse
    example for opt-in plugin.json validation on save.

Inbound-ref updates (files we own):
  README.md — \"AI Agent Guide\" points at AGENTS.md and notes
    .claude/ and copilot-instructions are tool-specific.
  CONTRIBUTING.md — \"Plugin System in CLAUDE.md\" -> docs/ and
    schema/; \"Git Workflow\" -> AGENTS.md#git-workflow.
  docs/sloppak-spec.md — plugin-system table cell -> docs/.

Out of scope (intentionally untouched):
  plugins/highway_3d/README.md (gitlink — plugin owns its docs).
  .specify/memory/constitution.md and other spec-kit artefacts
    (spec-kit owns that surface; CLAUDE.md still resolves
    transitively via the @-import).

Verification:
  pytest -q                                     # backend + schema tests pass
  python -c \"import json,glob,jsonschema; s=json.load(open('schema/plugin.schema.json')); [jsonschema.validate(json.load(open(p)), s) for p in sorted(glob.glob('plugins/*/plugin.json'))]\"
Signed-off-by: Miguel_LZPF <mgcdreamer@gmail.com>
2026-06-18 00:38:51 -07:00

99 lines
3.5 KiB
YAML

name: Sync VERSION from desktop release
# Updates the VERSION file in this repo whenever slopsmith-desktop
# publishes a new tagged release. slopsmith-desktop's build.yml
# dispatches the `desktop-released` event at the end of a successful
# tag build (see Versioning section in AGENTS.md). A `workflow_dispatch` trigger is
# kept for manual testing / recovery.
#
# Related issue: #81.
on:
repository_dispatch:
types: [desktop-released]
workflow_dispatch:
inputs:
version:
description: 'Version to sync (vX.Y.Z or X.Y.Z)'
required: true
permissions:
contents: write
# Serialize runs so a rapid-fire pair of dispatches can't produce a
# non-fast-forward push race. Later runs queue behind earlier ones.
concurrency:
group: sync-version
cancel-in-progress: false
jobs:
sync:
runs-on: ubuntu-latest
steps:
# Always operate on main regardless of trigger branch. repository_dispatch
# already runs against the default branch, but workflow_dispatch can be
# launched from any branch in the UI — pinning ref: main keeps both
# paths committing to the same place.
- uses: actions/checkout@v4
with:
ref: main
- name: Determine target version
id: v
# Pass untrusted payloads through env vars instead of ${{ }}
# expansion inside the shell body — inline expansion makes the
# script vulnerable to command injection if a dispatch client
# sent a value like `$(...)` or a quote break.
env:
RAW_DISPATCH: ${{ github.event.client_payload.version }}
RAW_INPUT: ${{ inputs.version }}
EVENT_NAME: ${{ github.event_name }}
run: |
if [ "$EVENT_NAME" = "workflow_dispatch" ]; then
raw="$RAW_INPUT"
else
raw="$RAW_DISPATCH"
fi
# Accept both "vX.Y.Z" and "X.Y.Z" on the wire.
version="${raw#v}"
# Anchored semver guard — rejects payloads like
# "soundfonts-v1" (seen in the desktop release list) or any
# stray text. The emitter side validates too, but we don't
# trust cross-repo inputs.
if ! [[ "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
echo "::error::Invalid version payload: '$raw'"
exit 1
fi
echo "version=$version" >> "$GITHUB_OUTPUT"
- name: Compare with current VERSION
id: cmp
env:
TARGET: ${{ steps.v.outputs.version }}
run: |
current=$(tr -d '[:space:]' < VERSION)
if [ "$current" = "$TARGET" ]; then
echo "No change (already at $current)."
echo "changed=false" >> "$GITHUB_OUTPUT"
else
echo "Bumping $current -> $TARGET."
echo "changed=true" >> "$GITHUB_OUTPUT"
echo "previous=$current" >> "$GITHUB_OUTPUT"
fi
- name: Commit and push
if: steps.cmp.outputs.changed == 'true'
env:
TARGET: ${{ steps.v.outputs.version }}
run: |
printf '%s\n' "$TARGET" > VERSION
git config user.name 'github-actions[bot]'
git config user.email 'github-actions[bot]@users.noreply.github.com'
git add VERSION
git commit -m "chore: sync VERSION to $TARGET (desktop release)"
# Explicit HEAD:main push — if workflow_dispatch was somehow
# launched with ref: main overridden in the UI, this still
# lands on main rather than pushing to whatever the tracking
# branch was.
git push origin HEAD:main