mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-09-14 13:59:18 +08:00
664052f8ea
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - The release channel system promotes builds canary → nightly → beta → stable, and stable releases publish a GitHub Release from `releases/vYYYY.MDD.P.md` > - The stable lane requires that notes file to exist inside the promoted source commit, but the file is named for the promotion date, which is unknown when the source commit is created > - A promoted beta can therefore never pass the notes check: every happy-path stable is forced through the candidate-branch fix path, with a soak-gate justification, for a notes-only change > - This pull request drafts the notes automatically when the beta is published and lets the stable promotion read them from `master` > - The benefit is a walkable stable happy path: the soak gate stays exact, notes get a real review window during the soak, and the justification path returns to its real purpose (cherry-picked fixes) ## Linked Issues or Issue Description **What existing behavior does this improve?** The stable promotion path in the release channel system (`release.yml`, `scripts/release.sh`). **Current behavior** `release.sh stable` requires `releases/vYYYY.MDD.P.md` in the checked-out source tree, and `publish_stable` checks out the exact promoted SHA. The soak gate requires a `beta/v*` tag to point at that same SHA. No commit can satisfy both for a promoted beta, so a stable promotion must cut a candidate branch with a notes-only commit and bypass the soak gate with a written justification. Release notes are also written at promotion time, under time pressure, with no review window. **Proposed behavior** When a beta publishes, a `draft_stable_notes` job generates a grouped notes skeleton at `releases/beta/v<beta-version>.md` and pushes it to a machine-owned branch; a human opens the PR and edits it during the 3-day soak. The stable preflight resolves notes before the `npm-stable` approval gate: source-tree notes first (the candidate fix path, unchanged), then the merged beta-keyed file on `master`; it fails early with the missing path named when neither exists. After the stable ships, a canonicalization job pushes a branch that moves the file to `releases/vYYYY.MDD.P.md`. Related (not duplicates): #11006 and #11008 introduced the nightly and beta lanes this builds on; older changelog PRs (for example #10669) authored notes manually at promotion time, which is the flow this replaces. **Reason and benefit** The happy path becomes: promote the exact soaked SHA, no justification, notes reviewed during the soak instead of written at the gate. The `releases/vYYYY.MDD.P.md` invariant still holds durably via the canonicalization PR. ## What Changed - `scripts/release.sh`: new `--notes-file PATH` (stable only) overrides where the pre-publish notes check looks, so notes can live outside the source checkout without dirtying the worktree. - `scripts/create-github-release.sh`: same `--notes-file` override for the GitHub Release body. - `scripts/draft-stable-notes.sh` (new): deterministic skeleton generator — commit subjects from the newest stable tag (falling back to the previous beta, then full history) to the beta's source commit, grouped into Features / Fixes / Other. - `.github/workflows/release.yml`: - `draft_stable_notes` job after `publish_beta`: runs the generator and force-pushes `release-notes/v<beta-version>`; the job summary links the compare page. It recreates the beta tag locally if the tag push was rejected (the known workflows-permission case), so drafting is not blocked on manual tag recovery. - `preflight_stable`: computes the target stable version (`release.sh stable --print-version`) and resolves the notes source (`source_tree` → `master_beta` → fail early / warn on dry run); new outputs. - `publish_stable`: materializes `master`-side notes into `RUNNER_TEMP` and passes `--notes-file` to both scripts; outputs the published stable version. - `canonicalize_stable_notes` job: pushes the `git mv` branch after a stable that used `master`-side notes. - `doc/RELEASING.md`, `doc/RELEASE-CHECKLIST.md`: document the drafted-notes flow, the preflight resolution order, and the canonicalization step; the LLM changelog flow now targets the draft branch during the soak. - `.agents/skills/release-changelog/SKILL.md`, `.agents/skills/release-changelog-discord-message/SKILL.md`: the notes-authoring skills now describe this flow — range ends at the beta source commit (not `HEAD`), the file is beta-keyed on the `release-notes/v<beta-version>` branch (seeded with `scripts/draft-stable-notes.sh` for betas that predate the automation), and the canonicalization link caveat is called out for announcements. ## Verification - `node --test scripts/draft-stable-notes.test.mjs` — 6 tests, temp git-repo fixtures: grouping, stable-tag range, previous-beta and full-history fallbacks, default output path, malformed version, missing tag. - `node --test scripts/release-lib.test.mjs` — unchanged suite still green. - `bash -n` on both changed shell scripts; `release.yml` re-parsed as YAML. - `./scripts/release.sh stable --print-version` unchanged (prints the next stable version); `--notes-file` on a non-stable channel fails with a clear error. - Not exercised end-to-end: the new workflow jobs need a real beta publish to run. The first beta after merge is the live test; the draft job is additive and cannot affect the publish result (it runs after `publish_beta` completes). ## Risks - Low risk to publishing itself: `--notes-file` defaults preserve today's behavior everywhere; the draft and canonicalization jobs are additive and run after the publishes succeed. - The preflight now fails a real stable run when no notes are found. That is the intended fail-early behavior (it previously failed later, inside `publish_stable`, after the `npm-stable` approval). - `draft_stable_notes` force-pushes only the machine-owned `release-notes/v<beta-version>` branch; a beta re-cut regenerates it cleanly. - The stable version computed at preflight could differ from the published one if a run crosses UTC midnight between the two jobs; the materialized notes are passed by path, so the publish still succeeds, and the canonicalization job uses the actually-published version. ## Model Used Claude Fable 5 (Claude Code) ## Pre-submission checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template
138 lines
4.0 KiB
Bash
Executable File
138 lines
4.0 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
|
|
REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
|
# shellcheck source=./release-lib.sh
|
|
. "$REPO_ROOT/scripts/release-lib.sh"
|
|
|
|
dry_run=false
|
|
version=""
|
|
notes_file_override=""
|
|
|
|
usage() {
|
|
cat <<'EOF'
|
|
Usage:
|
|
./scripts/create-github-release.sh <version> [--dry-run] [--notes-file PATH]
|
|
|
|
Examples:
|
|
./scripts/create-github-release.sh 2026.318.0
|
|
./scripts/create-github-release.sh 2026.318.0 --dry-run
|
|
./scripts/create-github-release.sh 2026.318.0 --notes-file /tmp/stable-notes.md
|
|
|
|
Notes:
|
|
- Run this after pushing the stable tag.
|
|
- Resolves the git remote automatically.
|
|
- In GitHub Actions, origin is used explicitly.
|
|
- If the release already exists, this script updates its title and notes.
|
|
EOF
|
|
}
|
|
|
|
while [ $# -gt 0 ]; do
|
|
case "$1" in
|
|
--dry-run) dry_run=true ;;
|
|
--notes-file)
|
|
shift
|
|
if [ $# -eq 0 ]; then
|
|
echo "Error: --notes-file requires a path." >&2
|
|
exit 1
|
|
fi
|
|
notes_file_override="$1"
|
|
;;
|
|
-h|--help)
|
|
usage
|
|
exit 0
|
|
;;
|
|
*)
|
|
if [ -n "$version" ]; then
|
|
echo "Error: only one version may be provided." >&2
|
|
exit 1
|
|
fi
|
|
version="$1"
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
if [ -z "$version" ]; then
|
|
usage
|
|
exit 1
|
|
fi
|
|
|
|
if [[ ! "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
|
echo "Error: version must be a stable calendar version like 2026.318.0." >&2
|
|
exit 1
|
|
fi
|
|
|
|
tag="v$version"
|
|
notes_file="$REPO_ROOT/releases/${tag}.md"
|
|
if [ -n "$notes_file_override" ]; then
|
|
notes_file="$notes_file_override"
|
|
fi
|
|
if [ "${GITHUB_ACTIONS:-}" = "true" ] && [ -z "${PUBLISH_REMOTE:-}" ] && git_remote_exists origin; then
|
|
PUBLISH_REMOTE=origin
|
|
fi
|
|
PUBLISH_REMOTE="$(resolve_release_remote)"
|
|
if ! command -v gh >/dev/null 2>&1; then
|
|
echo "Error: gh CLI is required to create GitHub releases." >&2
|
|
exit 1
|
|
fi
|
|
|
|
GITHUB_REPO="$(github_repo_from_remote "$PUBLISH_REMOTE" || true)"
|
|
if [ -z "$GITHUB_REPO" ]; then
|
|
echo "Error: could not determine GitHub repository from remote $PUBLISH_REMOTE." >&2
|
|
exit 1
|
|
fi
|
|
|
|
if [ ! -f "$notes_file" ]; then
|
|
echo "Error: release notes file not found at $notes_file." >&2
|
|
exit 1
|
|
fi
|
|
|
|
if ! git -C "$REPO_ROOT" rev-parse "$tag" >/dev/null 2>&1; then
|
|
echo "Error: local git tag $tag does not exist." >&2
|
|
exit 1
|
|
fi
|
|
|
|
# The catalog is derived from the checked-out sources, so it must be generated
|
|
# from the exact commit the release tag points at, with no local edits.
|
|
tag_commit="$(git -C "$REPO_ROOT" rev-parse "$tag^{commit}")"
|
|
head_commit="$(git -C "$REPO_ROOT" rev-parse HEAD)"
|
|
if [ "$head_commit" != "$tag_commit" ]; then
|
|
echo "Error: HEAD ($head_commit) does not match tag $tag ($tag_commit). Check out the release tag before generating the feature catalog." >&2
|
|
exit 1
|
|
fi
|
|
if [ -n "$(git -C "$REPO_ROOT" status --porcelain --untracked-files=no)" ]; then
|
|
echo "Error: working tree has uncommitted changes. The feature catalog must be generated from the pristine release commit." >&2
|
|
exit 1
|
|
fi
|
|
|
|
catalog_dir="$(mktemp -d)"
|
|
trap 'rm -rf "$catalog_dir"' EXIT
|
|
catalog_file="$catalog_dir/feature-catalog.json"
|
|
node "$REPO_ROOT/cli/node_modules/tsx/dist/cli.mjs" \
|
|
"$REPO_ROOT/scripts/generate-feature-catalog.ts" \
|
|
--version "$version" \
|
|
--out "$catalog_file"
|
|
|
|
if [ "$dry_run" = true ]; then
|
|
echo "[dry-run] gh release create $tag -R $GITHUB_REPO --title $tag --notes-file $notes_file"
|
|
echo "[dry-run] gh release upload $tag -R $GITHUB_REPO --clobber $catalog_file"
|
|
exit 0
|
|
fi
|
|
|
|
if ! git -C "$REPO_ROOT" ls-remote --exit-code --tags "$PUBLISH_REMOTE" "refs/tags/$tag" >/dev/null 2>&1; then
|
|
echo "Error: remote tag $tag was not found on $PUBLISH_REMOTE. Push the release commit and tag first." >&2
|
|
exit 1
|
|
fi
|
|
|
|
if gh release view "$tag" -R "$GITHUB_REPO" >/dev/null 2>&1; then
|
|
gh release edit "$tag" -R "$GITHUB_REPO" --title "$tag" --notes-file "$notes_file"
|
|
echo "Updated GitHub Release $tag"
|
|
else
|
|
gh release create "$tag" -R "$GITHUB_REPO" --title "$tag" --notes-file "$notes_file"
|
|
echo "Created GitHub Release $tag"
|
|
fi
|
|
|
|
gh release upload "$tag" -R "$GITHUB_REPO" --clobber "$catalog_file"
|
|
echo "Uploaded feature-catalog.json to GitHub Release $tag"
|