Skip to content

Make release script catch some mistakes #946

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.

Sign up for GitHub

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
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Make release script catch some mistakes #946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7402cb0
Commit Cargo files during release script
AndrewFerr Jun 20, 2024
aca1d2d
Change "y/N" prompt appearance to match towncrier
AndrewFerr Jun 20, 2024
774b348
Prompt before releasing with unstaged changes
AndrewFerr Jun 20, 2024
9ce8474
Revert releaser script to check working tree
AndrewFerr Jun 20, 2024
55b0074
Add changelog
AndrewFerr Jun 20, 2024
dc236a6
Rename changelog file
AndrewFerr Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/946.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update the releaser script to commit changes to the Cargo metadata files and to warn about uncommitted changes.
21 changes: 16 additions & 5 deletions scripts/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ then
exit 1
fi

VERSION=`jq -r .version <(git show :package.json)`
VERSION=`jq -r .version package.json`

function parseCargoVersion {
awk '$1 == "version" {gsub("\"", "", $3); print $3}' $1
}
CARGO_TOML_VERSION=`parseCargoVersion <(git show :Cargo.toml)`
CARGO_TOML_VERSION=`parseCargoVersion Cargo.toml`
if [[ $VERSION != $CARGO_TOML_VERSION ]]; then
echo "Node & Rust package versions do not match." >&2
echo "Node version (package.json): ${VERSION}" >&2
echo "Rust version (Cargo.toml): ${CARGO_TOML_VERSION}" >&2
exit 2
fi
CARGO_LOCK_VERSION=`parseCargoVersion <(grep -A1 matrix-hookshot <(git show :Cargo.lock))`
CARGO_LOCK_VERSION=`parseCargoVersion <(grep -A1 matrix-hookshot Cargo.lock)`
if [[ $CARGO_TOML_VERSION != $CARGO_LOCK_VERSION ]]; then
echo "Rust package version does not match the lockfile." >&2
echo "Rust version (Cargo.toml): ${CARGO_TOML_VERSION}" >&2
Expand All @@ -40,11 +40,22 @@ if [ $(git tag -l "$TAG") ]; then
exit 5
fi

GIT_STATUS=$(git status --porcelain | grep -vE 'package.json|Cargo.(lock|toml)')
if [[ -n $GIT_STATUS ]]; then
echo "Uncommitted changes:"
echo $GIT_STATUS
read -p "Continue anyways? [y/N] " prompt
if [[ $prompt != "y" && $prompt != "Y" && $prompt != "yes" && $prompt != "Yes" ]]
then
exit 0
fi
fi

echo "Drafting a new release"
towncrier build --draft --version $VERSION> draft-release.txt
cat draft-release.txt

read -p "Happy with the changelog? <y/N> " prompt
read -p "Happy with the changelog? [y/N] " prompt
if [[ $prompt != "y" && $prompt != "Y" && $prompt != "yes" && $prompt != "Yes" ]]
then
rm draft-release.txt
Expand All @@ -53,7 +64,7 @@ fi

echo "Committing version"
towncrier build --version $VERSION
git commit CHANGELOG.md changelog.d/ package.json -m $TAG
git commit CHANGELOG.md changelog.d/ package.json Cargo.toml Cargo.lock -m $TAG

echo "Proceeding to generate tags"
git tag -F draft-release.txt -s $TAG
Expand Down