Skip to content

docs: fix uninstall label list, outdated testing section, broken publishing link #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: fix uninstall label list, outdated testing section, broken publishing link #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,28 @@ Edit the relevant `SKILL.md` or data file. Test by running the skill locally wit

## Testing

There is no automated test harness for skills — they are instruction sets interpreted by Claude Code, not code with unit tests. The validation steps are:
The repo has a three-tier automated test suite in [`tests/`](tests/README.md). Run fast tests before opening a PR:

```bash
./tests/run-tests.sh # tier-2 invariants + tier-1 skill tests (~5 min)
./tests/run-tests.sh --verbose
```

| Tier | When to run | Cost |
|---|---|---|
| **2** (invariants) | Always — CI runs it on every PR. Filesystem/grep assertions, no Claude invocation. | <1 s |
| **1** (skill tests) | Always — CI runs it on every PR. Headless Claude prompts that assert skill behavior. | ~4–5 min, burns modest tokens |
| **3** (E2E, opt-in) | Before releases or when touching catalog/`*.md` workflow sources. Runs a real pipeline or provisions a throwaway repo. | 20–35 min, real wall-time |

Run tier-3 explicitly via `./tests/test-e2e.sh` (pipeline) or `./tests/test-e2e-install-workflow.sh` / `./tests/test-e2e-install-agent-team.sh` (skill install surfaces). See [`tests/README.md`](tests/README.md) for full usage.

Additional manual validation steps (no automated equivalent):

1. **Load the plugin**: `claude --plugin-dir .` — confirm no startup errors.
2. **Run the skill manually**: invoke `/discover-workflows` or `/install-workflow` and walk through the flow.
3. **Validate lock files** (if you changed `.lock.yml` files): `gh aw validate` — safe, does not recompile.
4. **Check grep counts** (if you applied the OAuth tweak): see [skills/install-workflow/auth.md](skills/install-workflow/auth.md#step-4--verify-the-tweak-shape).
2. **Validate lock files** (if you changed `.lock.yml` files): `gh aw validate` — safe, does not recompile.
3. **Check grep counts** (if you applied the OAuth tweak): see [skills/install-workflow/auth.md](skills/install-workflow/auth.md#step-4--verify-the-tweak-shape).

Never test by committing untested changes to `main`. The installed workflows run on push to `main`, so a broken install skill or a bad `.lock.yml` will trigger a live workflow run.
Never commit untested changes to `main`. The installed workflows run on push to `main`, so a broken skill or bad `.lock.yml` will trigger a live workflow run.

## Workflow files

Expand Down Expand Up @@ -112,4 +126,6 @@ Branch naming conventions:

## Publishing (maintainers only)

See the [Publishing section of the README](README.md#publishing) for the steps to submit the plugin to the Claude plugin registry.
1. Bump the version in `.claude-plugin/plugin.json` (`"version"` field). Keep `marketplace.json` in sync if the description changes.
2. Create a GitHub Release tagged `v<version>` — the release body becomes the changelog entry.
3. The plugin is listed on [claude-plugins.dev](https://claude-plugins.dev) and [ClaudePluginHub](https://claudepluginhub.com). Update the listing on each registry if the description, homepage, or marketplace URL changed.
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,17 @@ To remove workflows this plugin installed into your target repo:

- `gh aw remove <workflow>` for each installed workflow (deletes both the `.md` source and the compiled `.lock.yml`), then commit the deletion.
- `gh secret delete CLAUDE_CODE_OAUTH_TOKEN` — or `ANTHROPIC_API_KEY`, whichever path you used — to unset the auth secret.
- For `agent-team` specifically, also delete the seven labels: `gh label delete agent-team` plus `gh label delete state:<name>` for each of `plan-needed`, `impl-needed`, `review-needed`, `done`, `blocked`, and `in-progress`.
- For `agent-team` specifically, also delete the seven labels:

```bash
gh label delete agent-team
gh label delete state:plan-needed
gh label delete state:impl-needed
gh label delete state:review-needed
gh label delete state:done
gh label delete state:blocked
gh label delete agent-team:reviewed
```

Nothing else is persisted — the plugin writes only to your target repo (under user approval) and holds no local state outside Claude Code's own plugin directory.

Expand Down