aevgarik/paperclip
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: use origin for github release creation in actions

Browse Source
This commit is contained in:
dotta
2026-03-18 09:10:00 -05:00
parent 78c714c29a
commit 528f836e71
4 changed files with 26 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.github/workflows/release.yml vendored
View File

@@ -12,7 +12,7 @@ on:
type: string type: string
default: master default: master
stable_date: stable_date:
description: Stable release date in UTC (YYYY-MM-DD). First stable that day is .0, then .1, and so on. description: Enter a UTC date in YYYY-MM-DD format, for example 2026-03-18. Do not enter a version string. The workflow will resolve that date to a stable version such as 2026.318.0, then 2026.318.1 for the next same-day stable.
required: false required: false
type: string type: string
dry_run: dry_run:
@@ -251,6 +251,7 @@ jobs:
- name: Create GitHub Release - name: Create GitHub Release
env: env:
GH_TOKEN: ${{ github.token }} GH_TOKEN: ${{ github.token }}
PUBLISH_REMOTE: origin
run: | run: |
version="$(git tag --points-at HEAD | grep '^v' | head -1 | sed 's/^v//')" version="$(git tag --points-at HEAD | grep '^v' | head -1 | sed 's/^v//')"
if [ -z "$version" ]; then if [ -z "$version" ]; then

8
doc/RELEASE-AUTOMATION-SETUP.md
View File

@@ -222,7 +222,8 @@ After at least one good canary exists:
3. open `Actions` -> `Release` 3. open `Actions` -> `Release`
4. run it with: 4. run it with:
- `source_ref`: the tested commit SHA or canary tag source commit - `source_ref`: the tested commit SHA or canary tag source commit
- `stable_date`: leave blank or set the intended UTC date - `stable_date`: leave blank or set the intended UTC date like `2026-03-18`
do not enter a version like `2026.318.0`; the workflow computes that from the date
- `dry_run`: `true` - `dry_run`: `true`
5. confirm the dry-run succeeds 5. confirm the dry-run succeeds
6. rerun with `dry_run: false` 6. rerun with `dry_run: false`
@@ -231,6 +232,11 @@ After at least one good canary exists:
9. confirm git tag `vYYYY.MDD.P` exists 9. confirm git tag `vYYYY.MDD.P` exists
10. confirm the GitHub Release was created 10. confirm the GitHub Release was created
Implementation note:
- the GitHub Actions stable workflow calls `create-github-release.sh` with `PUBLISH_REMOTE=origin`
- local maintainer usage can still pass `PUBLISH_REMOTE=public-gh` explicitly when needed
## 13. Suggested Maintainer Policy ## 13. Suggested Maintainer Policy
Use this policy going forward: Use this policy going forward:

15
doc/RELEASING.md
View File

@@ -77,22 +77,31 @@ npx paperclipai@canary onboard --data-dir "$(mktemp -d /tmp/paperclip-canary.XXX
Use [`.github/workflows/release.yml`](../.github/workflows/release.yml) from the Actions tab with the manual `workflow_dispatch` inputs. Use [`.github/workflows/release.yml`](../.github/workflows/release.yml) from the Actions tab with the manual `workflow_dispatch` inputs.
[Run the action here](https://github.com/paperclipai/paperclip/actions/workflows/release.yml)
Inputs: Inputs:
- `source_ref` - `source_ref`
- commit SHA, branch, or tag - commit SHA, branch, or tag
- `stable_date` - `stable_date`
- optional UTC date override in `YYYY-MM-DD` - optional UTC date override in `YYYY-MM-DD`
- enter a date like `2026-03-18`, not a version like `2026.318.0`
- `dry_run` - `dry_run`
- preview only when true - preview only when true
Before running stable: Before running stable:
1. pick the canary commit or tag you trust 1. pick the canary commit or tag you trust
2. resolve the target stable version with `./scripts/release.sh stable --date YYYY-MM-DD --print-version` 2. resolve the target stable version with `./scripts/release.sh stable --date "$(date +%F)" --print-version`
3. create or update `releases/vYYYY.MDD.P.md` on that source ref 3. create or update `releases/vYYYY.MDD.P.md` on that source ref
4. run the stable workflow from that source ref 4. run the stable workflow from that source ref
Example:
- `source_ref`: `master`
- `stable_date`: `2026-03-18`
- resulting stable version: `2026.318.0`
The workflow: The workflow:
- re-verifies the exact source ref - re-verifies the exact source ref
@@ -122,7 +131,7 @@ This is mainly for emergency/manual use. The normal path is the GitHub workflow.
```bash ```bash
./scripts/release.sh stable ./scripts/release.sh stable
git push public-gh refs/tags/vYYYY.MDD.P git push public-gh refs/tags/vYYYY.MDD.P
./scripts/create-github-release.sh YYYY.MDD.P PUBLISH_REMOTE=public-gh ./scripts/create-github-release.sh YYYY.MDD.P
``` ```
## Stable Changelog Workflow ## Stable Changelog Workflow
@@ -217,7 +226,7 @@ This is a partial release. npm is already live.
Do this immediately: Do this immediately:
1. push the missing tag 1. push the missing tag
2. rerun `./scripts/create-github-release.sh YYYY.MDD.P` 2. rerun `PUBLISH_REMOTE=public-gh ./scripts/create-github-release.sh YYYY.MDD.P`
3. verify the GitHub Release notes point at `releases/vYYYY.MDD.P.md` 3. verify the GitHub Release notes point at `releases/vYYYY.MDD.P.md`
Do not republish the same version. Do not republish the same version.

7
scripts/create-github-release.sh
View File

@@ -19,7 +19,8 @@ Examples:
Notes: Notes:
- Run this after pushing the stable tag. - Run this after pushing the stable tag.
- Defaults to git remote public-gh. - Resolves the git remote automatically.
- In GitHub Actions, origin is used explicitly.
- If the release already exists, this script updates its title and notes. - If the release already exists, this script updates its title and notes.
EOF EOF
} }
@@ -54,7 +55,9 @@ fi
tag="v$version" tag="v$version"
notes_file="$REPO_ROOT/releases/${tag}.md" notes_file="$REPO_ROOT/releases/${tag}.md"
PUBLISH_REMOTE="${PUBLISH_REMOTE:-public-gh}" if [ "${GITHUB_ACTIONS:-}" = "true" ] && [ -z "${PUBLISH_REMOTE:-}" ] && git_remote_exists origin; then
PUBLISH_REMOTE=origin
fi
PUBLISH_REMOTE="$(resolve_release_remote)" PUBLISH_REMOTE="$(resolve_release_remote)"
if ! command -v gh >/dev/null 2>&1; then if ! command -v gh >/dev/null 2>&1; then
echo "Error: gh CLI is required to create GitHub releases." >&2 echo "Error: gh CLI is required to create GitHub releases." >&2