Skip to content

Commit e76b083

Browse files
refactor(scripts): rename prepare-release.sh to prepare-github-releas… (#4099)
1 parent d45bd9b commit e76b083

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

.cliffignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Commits to exclude from the changelog (read by git-cliff via cliff.toml,
2-
# invoked from scripts/ops/prepare-release.sh and the manual flow in RELEASES.md).
2+
# invoked from scripts/ops/prepare-github-release.sh and the manual flow in RELEASES.md).
33
# The block below is the 502 commits from the threshold-signatures repo that
44
# were merged in 59037a57 ("Merge threshold-signatures repo"). Their full
55
# pre-merge history would otherwise pollute the changelog.

.github/prompts/pr-review.prompt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ REVIEW STYLE:
5656
- Flag code-comment quality issues per [engineering-standards.md]. The goal is to avoid comments that may become stale or add little value to the reader.
5757
- Do NOT comment on style, formatting, or naming unless it causes a bug.
5858
- Do NOT restate what the diff already shows
59-
- Do NOT ask for `third-party-licenses/licenses.html` to be regenerated on a dependency or lockfile change. Those notices are refreshed during release preparation by [prepare-release.sh]; drift between releases is expected and no CI job gates it. Stale notices are only a finding on a release PR, where that script should already have refreshed them.
59+
- Do NOT ask for `third-party-licenses/licenses.html` to be regenerated on a dependency or lockfile change. Those notices are refreshed during release preparation by [prepare-github-release.sh]; drift between releases is expected and no CI job gates it. Stale notices are only a finding on a release PR, where that script should already have refreshed them.
6060
- If no critical issues found: approve with a one-line summary
6161
- Sign off with: ✅ (approved) or ⚠️ (issues found)
6262

@@ -109,4 +109,4 @@ Please always use `gh pr comment` to post your review instead.
109109
[AGENTS.md]: ../../AGENTS.md
110110
[CONTRIBUTING.md]: ../../CONTRIBUTING.md
111111
[engineering-standards.md]: ../../docs/engineering-standards.md
112-
[prepare-release.sh]: ../../scripts/ops/prepare-release.sh
112+
[prepare-github-release.sh]: ../../scripts/ops/prepare-github-release.sh

RELEASES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,19 @@ with whatever version you're releasing.
5353
### 1. Prepare the release PR
5454

5555
Create a working branch off the release-source branch, then run
56-
[`scripts/ops/prepare-release.sh`](./scripts/ops/prepare-release.sh) to apply the
56+
[`scripts/ops/prepare-github-release.sh`](./scripts/ops/prepare-github-release.sh) to apply the
5757
release boilerplate (changelog, version bump, ABI snapshot, licenses):
5858

5959
```sh
6060
# For a minor/major release:
6161
git checkout main && git pull
6262
git checkout -b release-prep/v3.11.0
63-
./scripts/ops/prepare-release.sh 3.11.0
63+
./scripts/ops/prepare-github-release.sh 3.11.0
6464

6565
# For a patch release:
6666
git checkout release/v3.11 && git pull
6767
git checkout -b release-prep/v3.11.1
68-
./scripts/ops/prepare-release.sh 3.11.1
68+
./scripts/ops/prepare-github-release.sh 3.11.1
6969
```
7070

7171
Push the working branch and open a PR against `main` (for minor releases)
@@ -233,7 +233,7 @@ We follow [Semantic Versioning](https://semver.org/) with these compatibility ru
233233
## Changelog conventions
234234

235235
We use [`git-cliff`](https://git-cliff.org/) to maintain `CHANGELOG.md`.
236-
The `scripts/ops/prepare-release.sh` script invokes `git-cliff -t <VERSION>
236+
The `scripts/ops/prepare-github-release.sh` script invokes `git-cliff -t <VERSION>
237237
<BASE_TAG>..<HEAD-SHA>`, where `BASE_TAG` is the most recent **semver**
238238
tag (`X.Y.Z`) reachable from `HEAD`, found via `git describe` with a
239239
`--match` glob that skips stray non-semver tags. The range head is a
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env bash
22
#
3-
# prepare-release.sh — Apply the local file changes for a release.
3+
# prepare-github-release.sh — Apply the local file changes for a release.
44
#
55
# Run this on a working branch off the release-source branch (e.g. off
66
# `main` for a minor release, off `release/vX.Y` for a patch). The script
@@ -14,8 +14,8 @@
1414
# 4. Regenerate third-party licenses
1515
# 5. Commit the release changes
1616
#
17-
# Usage: ./scripts/ops/prepare-release.sh <VERSION>
18-
# Example: ./scripts/ops/prepare-release.sh 3.6.0
17+
# Usage: ./scripts/ops/prepare-github-release.sh <VERSION>
18+
# Example: ./scripts/ops/prepare-github-release.sh 3.6.0
1919
#
2020

2121
set -euo pipefail

0 commit comments

Comments
 (0)