github/shellcheck
1
0
Fork 0
mirror of https://github.com/koalaman/shellcheck synced 2025-08-19 21:03:51 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update release checklist

Browse source
This commit is contained in:
Vidar Holen 2025-08-03 18:00:58 -07:00
commit 5cc026842e
1 changed files with 33 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

61
test/check_release
View file

@ -7,6 +7,39 @@ fail() {
failed=1
}
i=1 j=1
cat << EOF
Manual Checklist
$((i++)). Make sure README.md examples are up to date
$((i++)). Format and read over the manual for bad formatting and outdated info.
$((i++)). Run \`builders/build_builder build/*/\` to update all builder images.
$((i++)). \`builders/run_builder dist-newstyle/sdist/ShellCheck-*.tar.gz builders/*/\` to verify that they work.
$((i++)). \`for f in \$(cat build/*/tag); do docker push "\$f"; done\` to upload them.
$((i++)). Run test/distrotest to ensure that most distros can build OOTB.
$((i++)). Make sure GitHub Build currently passes: https://github.com/koalaman/shellcheck/actions
$((i++)). Make sure SnapCraft build currently works: https://snapcraft.io/shellcheck/builds
$((i++)). Make sure the Hackage package builds locally.
$((i++)). Make sure none of the automated checks below fail
Release Steps
$((j++)). \`cabal sdist\` to generate a Hackage package
$((j++)). \`git push --follow-tags\` to push commit
$((j++)). Wait for GitHub Actions to build. (v0.11.0 "Deploy" failed, but worked on retry)
$((j++)). Verify release:
a. Check that the new versions are uploaded: https://github.com/koalaman/shellcheck/tags
b. Check that the docker images have version tags: https://hub.docker.com/u/koalaman
$((j++)). If no disaster, upload to Hackage: http://hackage.haskell.org/upload
$((j++)). Run 'autoupdate' from https://github.com/koalaman/shellcheck-precommit
$((j++)). Release new snap versions on https://snapcraft.io/shellcheck/releases
$((j++)). Push a new commit that updates CHANGELOG.md
Automated Checks
EOF
if git diff | grep -q ""
then
fail "There are uncommitted changes"
@ -54,32 +87,4 @@ if [[ $(git log -1 --pretty=%B) != "Stable version "* ]]
then
fail "Expected git log message to be 'Stable version ...'"
fi
i=1 j=1
cat << EOF
Manual Checklist
$((i++)). Make sure none of the automated checks above failed
$((i++)). Run \`builders/build_builder build/*/\` to update all builder images.
$((j++)). \`builders/run_builder dist-newstyle/sdist/ShellCheck-*.tar.gz builders/*/\` to verify that they work.
$((j++)). \`for f in \$(cat build/*/tag); do docker push "\$f"; done\` to upload them.
$((i++)). Run test/distrotest to ensure that most distros can build OOTB.
$((i++)). Make sure GitHub Build currently passes: https://github.com/koalaman/shellcheck/actions
$((i++)). Make sure SnapCraft build currently works: https://snapcraft.io/shellcheck/builds
$((i++)). Format and read over the manual for bad formatting and outdated info.
$((i++)). Make sure the Hackage package builds locally.
Release Steps
$((j++)). \`cabal sdist\` to generate a Hackage package
$((j++)). \`git push --follow-tags\` to push commit
$((j++)). Wait for GitHub Actions to build.
$((j++)). Verify release:
a. Check that the new versions are uploaded: https://github.com/koalaman/shellcheck/tags
b. Check that the docker images have version tags: https://hub.docker.com/u/koalaman
$((j++)). If no disaster, upload to Hackage: http://hackage.haskell.org/upload
$((j++)). Push a new commit that updates CHANGELOG.md
$((j++)). Run 'autoupdate' from https://github.com/koalaman/shellcheck-precommit
EOF
exit "$failed"