-
Notifications
You must be signed in to change notification settings - Fork 0
Add release script wrapping cargo release #8
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.
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
Open
pthurlow
wants to merge
2
commits into
main
Choose a base branch
from
fix/release-script
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,84 @@ | ||||||||||||||
| #!/usr/bin/env bash | ||||||||||||||
| # release.sh — two-phase release wrapper around cargo-release | ||||||||||||||
| # | ||||||||||||||
| # Usage: | ||||||||||||||
| # scripts/release.sh prepare <version> # steps 0-2: branch, bump, push PR | ||||||||||||||
| # scripts/release.sh finish # step 4: tag, publish, trigger dist | ||||||||||||||
|
|
||||||||||||||
| set -euo pipefail | ||||||||||||||
|
|
||||||||||||||
| COMMAND="${1:-}" | ||||||||||||||
| VERSION="${2:-}" | ||||||||||||||
|
|
||||||||||||||
| usage() { | ||||||||||||||
| echo "Usage:" | ||||||||||||||
| echo " scripts/release.sh prepare <version> # create release branch and open PR" | ||||||||||||||
| echo " scripts/release.sh finish # tag and publish from main" | ||||||||||||||
| exit 1 | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| require_clean_tree() { | ||||||||||||||
| if ! git diff --quiet || ! git diff --cached --quiet; then | ||||||||||||||
| echo "error: working tree is not clean. Commit or stash your changes first." | ||||||||||||||
| exit 1 | ||||||||||||||
| fi | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| case "$COMMAND" in | ||||||||||||||
| prepare) | ||||||||||||||
| if [ -z "$VERSION" ]; then | ||||||||||||||
| echo "error: version required (e.g. scripts/release.sh prepare 0.2.0)" | ||||||||||||||
| usage | ||||||||||||||
| fi | ||||||||||||||
|
|
||||||||||||||
| BRANCH="release/$VERSION" | ||||||||||||||
|
|
||||||||||||||
| # step 0: create release branch | ||||||||||||||
| echo "→ Creating branch $BRANCH" | ||||||||||||||
| git checkout -b "$BRANCH" | ||||||||||||||
|
|
||||||||||||||
| # step 2: bump versions, commit, push branch | ||||||||||||||
| echo "" | ||||||||||||||
| echo "→ Running cargo release (no publish, no tag)..." | ||||||||||||||
| cargo release --no-publish --no-tag --allow-branch="$BRANCH" "$VERSION" | ||||||||||||||
|
|
||||||||||||||
| echo "" | ||||||||||||||
| echo "→ Opening pull request..." | ||||||||||||||
| PR_URL=$(gh pr create \ | ||||||||||||||
| --title "chore: Release hotdata-cli version $VERSION" \ | ||||||||||||||
| --base main \ | ||||||||||||||
| --head "$BRANCH") | ||||||||||||||
|
|
||||||||||||||
| echo "" | ||||||||||||||
| echo "✓ PR created: $PR_URL" | ||||||||||||||
| open "$PR_URL" | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Use a cross-platform helper:
Suggested change
|
||||||||||||||
| echo "" | ||||||||||||||
| echo "Next steps:" | ||||||||||||||
| echo " 1. Review and merge the PR (use 'Squash and merge')" | ||||||||||||||
| echo " 2. Run: scripts/release.sh finish" | ||||||||||||||
| ;; | ||||||||||||||
|
|
||||||||||||||
| finish) | ||||||||||||||
| require_clean_tree | ||||||||||||||
|
|
||||||||||||||
| CURRENT_BRANCH="$(git rev-parse --abbrev-ref HEAD)" | ||||||||||||||
| if [ "$CURRENT_BRANCH" != "main" ]; then | ||||||||||||||
| echo "→ Switching to main..." | ||||||||||||||
| git checkout main | ||||||||||||||
| fi | ||||||||||||||
|
|
||||||||||||||
| echo "→ Pulling latest main..." | ||||||||||||||
| git pull | ||||||||||||||
|
|
||||||||||||||
| echo "" | ||||||||||||||
| echo "→ Running cargo release (tagging release)..." | ||||||||||||||
| cargo release | ||||||||||||||
|
|
||||||||||||||
| echo "" | ||||||||||||||
| echo "✓ Release complete. Tag pushed and dist workflow triggered." | ||||||||||||||
| ;; | ||||||||||||||
|
|
||||||||||||||
| *) | ||||||||||||||
| usage | ||||||||||||||
| ;; | ||||||||||||||
| esac | ||||||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider calling
require_clean_treebefore checking out the new branch.cargo releasewill modifyCargo.toml/CHANGELOG.md, so starting from a dirty tree can produce confusing diffs or cause cargo-release to abort mid-run.