Skip to content

docs: end-user README + fix release artifact pipeline - #5

Merged
wavekat-eason merged 2 commits into
mainfrom
docs/readme-user-friendly
Apr 28, 2026
Merged

docs: end-user README + fix release artifact pipeline#5
wavekat-eason merged 2 commits into
mainfrom
docs/readme-user-friendly

Conversation

@wavekat-eason

Copy link
Copy Markdown
Contributor

Summary

  • Rewrite the README from an end-user perspective: 3-line Quick Start up top, drop API endpoints from the main command table (moved to a separate API reference section), simplify the sign-in walkthrough from 5 mechanism-heavy steps to 2 sentences, replace the pinned `WK_VERSION=v0.0.3` example with a placeholder, and add a help/feedback section.
  • Fix the release artifact pipeline: `release-plz` creates the GitHub release using `GITHUB_TOKEN`, which GitHub suppresses from triggering downstream `release: [published]` events — so `release.yml` never fired and no binaries or `install.sh` got attached to v0.0.1–v0.0.3. Dispatch `release.yml` explicitly via `workflow_dispatch` (which does fire under `GITHUB_TOKEN`) using the tag(s) `release-plz` reports as published.

Note: this PR fixes future releases. v0.0.3 still needs a manual backfill — run `gh workflow run release.yml -f tag=v0.0.3` to attach assets to the existing release so the README's curl|sh URL resolves.

Test plan

  • Merge, then verify the next release-plz run dispatches `release.yml` and the new release ends up with all four target tarballs + `install.sh` attached.
  • After backfilling v0.0.3 (or the next release), confirm `curl -fsSL https://github.com/wavekat/wavekat-cli/releases/latest/download/install.sh | sh` works end-to-end.
  • Render the README on GitHub and sanity-check the Quick Start, table, and section anchors.

🤖 Generated with Claude Code

wavekat-eason and others added 2 commits April 28, 2026 15:33
Lead with a 3-line Quick Start, drop API endpoints from the main
command table (moved to a separate API reference section), simplify
the sign-in walkthrough, and add a help/feedback section. Replace the
pinned WK_VERSION example with a placeholder so it doesn't go stale.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
GitHub suppresses the release:[published] event when a release is
created via GITHUB_TOKEN, so the existing release.yml never fired and
no binaries or install.sh got attached to v0.0.1–v0.0.3. Dispatch
release.yml explicitly via workflow_dispatch (which does fire under
GITHUB_TOKEN) using the tag(s) release-plz reports as published.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@wavekat-eason
wavekat-eason merged commit a22a15c into main Apr 28, 2026
3 checks passed
@wavekat-eason
wavekat-eason deleted the docs/readme-user-friendly branch April 28, 2026 03:36
@github-actions github-actions Bot mentioned this pull request Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant