chore: create_release check for unused lint

This commit is contained in:
Jack Wills
2024-01-13 13:31:53 +00:00
parent c9049dacd9
commit d0b2721192
+72 -62
View File
@@ -1,7 +1,7 @@
#!/bin/bash #!/bin/bash
# rust create_release # rust create_release
# v0.3.1 # v0.4.1
STAR_LINE='****************************************' STAR_LINE='****************************************'
CWD=$(pwd) CWD=$(pwd)
@@ -12,15 +12,14 @@ YELLOW='\033[0;33m'
PURPLE='\033[0;35m' PURPLE='\033[0;35m'
RESET='\033[0m' RESET='\033[0m'
# $1 string - error message # $1 string - error message
error_close() { error_close() {
echo -e "\n${RED}ERROR - EXITED: ${YELLOW}$1${RESET}\n"; echo -e "\n${RED}ERROR - EXITED: ${YELLOW}$1${RESET}\n"
exit 1 exit 1
} }
# $1 string - question to ask # $1 string - question to ask
ask_yn () { ask_yn() {
printf "%b%s? [y/N]:%b " "${GREEN}" "$1" "${RESET}" printf "%b%s? [y/N]:%b " "${GREEN}" "$1" "${RESET}"
} }
@@ -30,19 +29,19 @@ user_input() {
echo "$data" echo "$data"
} }
update_major () { update_major() {
local bumped_major local bumped_major
bumped_major=$((MAJOR + 1)) bumped_major=$((MAJOR + 1))
echo "${bumped_major}.0.0" echo "${bumped_major}.0.0"
} }
update_minor () { update_minor() {
local bumped_minor local bumped_minor
bumped_minor=$((MINOR + 1)) bumped_minor=$((MINOR + 1))
echo "${MAJOR}.${bumped_minor}.0" echo "${MAJOR}.${bumped_minor}.0"
} }
update_patch () { update_patch() {
local bumped_patch local bumped_patch
bumped_patch=$((PATCH + 1)) bumped_patch=$((PATCH + 1))
echo "${MAJOR}.${MINOR}.${bumped_patch}" echo "${MAJOR}.${MINOR}.${bumped_patch}"
@@ -56,8 +55,7 @@ get_git_remote_url() {
# Check that git status is clean # Check that git status is clean
check_git_clean() { check_git_clean() {
GIT_CLEAN=$(git status --porcelain) GIT_CLEAN=$(git status --porcelain)
if [[ -n $GIT_CLEAN ]] if [[ -n $GIT_CLEAN ]]; then
then
error_close "git dirty" error_close "git dirty"
fi fi
} }
@@ -66,8 +64,7 @@ check_git_clean() {
check_git() { check_git() {
CURRENT_GIT_BRANCH=$(git branch --show-current) CURRENT_GIT_BRANCH=$(git branch --show-current)
check_git_clean check_git_clean
if [[ ! "$CURRENT_GIT_BRANCH" =~ ^dev$ ]] if [[ ! "$CURRENT_GIT_BRANCH" =~ ^dev$ ]]; then
then
error_close "not on dev branch" error_close "not on dev branch"
fi fi
} }
@@ -79,8 +76,7 @@ ask_changelog_update() {
printf "%s" "$RELEASE_BODY_TEXT" printf "%s" "$RELEASE_BODY_TEXT"
printf "\n%s\n" "${STAR_LINE}" printf "\n%s\n" "${STAR_LINE}"
ask_yn "accept release body" ask_yn "accept release body"
if [[ "$(user_input)" =~ ^y$ ]] if [[ "$(user_input)" =~ ^y$ ]]; then
then
update_release_body_and_changelog "$RELEASE_BODY_TEXT" update_release_body_and_changelog "$RELEASE_BODY_TEXT"
else else
exit exit
@@ -90,16 +86,16 @@ ask_changelog_update() {
# Edit the release-body to include new lines from changelog # Edit the release-body to include new lines from changelog
# add commit urls to changelog # add commit urls to changelog
# $1 RELEASE_BODY # $1 RELEASE_BODY
update_release_body_and_changelog () { update_release_body_and_changelog() {
echo -e echo -e
DATE_SUBHEADING="### $(date +'%Y-%m-%d')\n\n" DATE_SUBHEADING="### $(date +'%Y-%m-%d')\n\n"
RELEASE_BODY_ADDITION="${DATE_SUBHEADING}$1" RELEASE_BODY_ADDITION="${DATE_SUBHEADING}$1"
# Put new changelog entries into release-body, add link to changelog # Put new changelog entries into release-body, add link to changelog
echo -e "${RELEASE_BODY_ADDITION}\n\nsee <a href='${GIT_REPO_URL}/blob/main/CHANGELOG.md'>CHANGELOG.md</a> for more details" > .github/release-body.md echo -e "${RELEASE_BODY_ADDITION}\n\nsee <a href='${GIT_REPO_URL}/blob/main/CHANGELOG.md'>CHANGELOG.md</a> for more details" >.github/release-body.md
# Add subheading with release version and date of release # Add subheading with release version and date of release
echo -e "# <a href='${GIT_REPO_URL}/releases/tag/${NEW_TAG_WITH_V}'>${NEW_TAG_WITH_V}</a>\n${DATE_SUBHEADING}${CHANGELOG_ADDITION}$(cat CHANGELOG.md)" > CHANGELOG.md echo -e "# <a href='${GIT_REPO_URL}/releases/tag/${NEW_TAG_WITH_V}'>${NEW_TAG_WITH_V}</a>\n${DATE_SUBHEADING}${CHANGELOG_ADDITION}$(cat CHANGELOG.md)" >CHANGELOG.md
# Update changelog to add links to commits [hex:8](url_with_full_commit) # Update changelog to add links to commits [hex:8](url_with_full_commit)
# "[aaaaaaaaaabbbbbbbbbbccccccccccddddddddd]" -> "[aaaaaaaa](https:/www.../commit/aaaaaaaaaabbbbbbbbbbccccccccccddddddddd)" # "[aaaaaaaaaabbbbbbbbbbccccccccccddddddddd]" -> "[aaaaaaaa](https:/www.../commit/aaaaaaaaaabbbbbbbbbbccccccccccddddddddd)"
@@ -111,20 +107,19 @@ update_release_body_and_changelog () {
} }
# update version in cargo.toml, to match selected current version # update version in cargo.toml, to match selected current version
update_version_number_in_files () { update_version_number_in_files() {
sed -i "s|^version = .*|version = \"${MAJOR}.${MINOR}.${PATCH}\"|" Cargo.toml sed -i "s|^version = .*|version = \"${MAJOR}.${MINOR}.${PATCH}\"|" Cargo.toml
} }
# Work out the current version, based on git tags # Work out the current version, based on git tags
# create new semver version based on user input # create new semver version based on user input
# Set MAJOR MINOR PATCH # Set MAJOR MINOR PATCH
check_tag () { check_tag() {
LATEST_TAG=$(git describe --tags "$(git rev-list --tags --max-count=1)") LATEST_TAG=$(git describe --tags "$(git rev-list --tags --max-count=1)")
echo -e "\nCurrent tag: ${PURPLE}${LATEST_TAG}${RESET}\n" echo -e "\nCurrent tag: ${PURPLE}${LATEST_TAG}${RESET}\n"
echo -e "${YELLOW}Choose new tag version:${RESET}\n" echo -e "${YELLOW}Choose new tag version:${RESET}\n"
if [[ $LATEST_TAG =~ ^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-((0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$ ]] if [[ $LATEST_TAG =~ ^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-((0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$ ]]; then
then IFS="." read -r MAJOR MINOR PATCH <<<"${LATEST_TAG:1}"
IFS="." read -r MAJOR MINOR PATCH <<< "${LATEST_TAG:1}"
else else
MAJOR="0" MAJOR="0"
MINOR="0" MINOR="0"
@@ -134,51 +129,53 @@ check_tag () {
OP_MINOR="minor___v$(update_minor)" OP_MINOR="minor___v$(update_minor)"
OP_PATCH="patch___v$(update_patch)" OP_PATCH="patch___v$(update_patch)"
OPTIONS=("$OP_MAJOR" "$OP_MINOR" "$OP_PATCH") OPTIONS=("$OP_MAJOR" "$OP_MINOR" "$OP_PATCH")
select choice in "${OPTIONS[@]}" select choice in "${OPTIONS[@]}"; do
do
case $choice in case $choice in
"$OP_MAJOR" ) "$OP_MAJOR")
MAJOR=$((MAJOR + 1)) MAJOR=$((MAJOR + 1))
MINOR=0 MINOR=0
PATCH=0 PATCH=0
break;; break
"$OP_MINOR") ;;
MINOR=$((MINOR + 1)) "$OP_MINOR")
PATCH=0 MINOR=$((MINOR + 1))
break;; PATCH=0
"$OP_PATCH") break
PATCH=$((PATCH + 1)) ;;
break;; "$OP_PATCH")
*) PATCH=$((PATCH + 1))
error_close "invalid option $REPLY" break
;;
*)
error_close "invalid option $REPLY"
;;
esac esac
done done
} }
# ask continue, or quit # ask continue, or quit
ask_continue () { ask_continue() {
ask_yn "continue" ask_yn "continue"
if [[ ! "$(user_input)" =~ ^y$ ]] if [[ ! "$(user_input)" =~ ^y$ ]]; then
then
exit exit
fi fi
} }
# run all tests # run all tests
cargo_test () { cargo_test() {
cargo test -- --test-threads=1 cargo test -- --test-threads=1
ask_continue ask_continue
} }
# Simulate publishing to crates.io # Simulate publishing to crates.io
cargo_publish () { cargo_publish() {
cargo publish --dry-run cargo publish --dry-run
ask_continue ask_continue
} }
# Build all releases that GitHub workflow would # Build all releases that GitHub workflow would
# This will download GB's of docker images # This will download GB's of docker images
cargo_build () { cargo_build() {
cargo install cross cargo install cross
cargo_clean cargo_clean
echo -e "${YELLOW}cross build --target x86_64-unknown-linux-musl --release${RESET}" echo -e "${YELLOW}cross build --target x86_64-unknown-linux-musl --release${RESET}"
@@ -199,9 +196,8 @@ cargo_build () {
cargo_clean cargo_clean
} }
# $1 text to colourise # $1 text to colourise
release_continue () { release_continue() {
echo -e "\n${PURPLE}$1${RESET}" echo -e "\n${PURPLE}$1${RESET}"
ask_continue ask_continue
} }
@@ -212,14 +208,26 @@ cargo_clean() {
cargo clean cargo clean
} }
# Check repository for typos # Check repository for typos
check_typos () { check_typos() {
echo -e "\n${PURPLE}check typos${RESET}" echo -e "\n${PURPLE}check typos${RESET}"
typos typos
ask_continue ask_continue
} }
# Make sure the unused lint isn't used
check_allow_unsued() {
matches_any=$(find . -type d \( -name .git -o -name target \) -prune -o -type f -exec grep -lE '^#!\[allow\(unused\)\]$' {} +)
matches_cargo=$(grep "^unused = \"allow\"" ./Cargo.toml)
if [ -n "$matches_any" ]; then
error_close "\"#[allow(unused)]\" in ${matches_any}"
elif [ -n "$matches_cargo" ]; then
error_close "\"unsed = \"allow\"\" in Cargo.toml"
fi
}
# Full flow to create a new release # Full flow to create a new release
release_flow() { release_flow() {
check_allow_unsued
check_typos check_typos
check_git check_git
@@ -283,7 +291,6 @@ release_flow() {
git branch -d "$RELEASE_BRANCH" git branch -d "$RELEASE_BRANCH"
} }
main() { main() {
cmd=(dialog --backtitle "Choose option" --radiolist "choose" 14 80 16) cmd=(dialog --backtitle "Choose option" --radiolist "choose" 14 80 16)
options=( options=(
@@ -297,22 +304,25 @@ main() {
if [ $exitStatus -ne 0 ]; then if [ $exitStatus -ne 0 ]; then
exit exit
fi fi
for choice in $choices for choice in $choices; do
do
case $choice in case $choice in
0) 0)
exit;; exit
1) ;;
cargo_test 1)
main cargo_test
break;; main
2) break
release_flow ;;
break;; 2)
3) release_flow
cargo_build break
main ;;
break;; 3)
cargo_build
main
break
;;
esac esac
done done
} }