please-release-me 2.1.6 → 3.1.0

package/README.md

@@ -15,7 +15,7 @@
 ## What is it?
 
 An automated release script
-for npm, Rust and Python,
+for npm, Go, Rust and Python,
 built to work with
 the conventions
 used by my packages.
@@ -75,43 +75,35 @@ in order:
    * Otherwise,
      increment the patch number.
 
-7. If `bower.json` exists,
-   write the freshly bumped version string
-   to `bower.json`.
-
-8. If `component.json` exists,
-   write the freshly bumped version string
-   to `component.json`.
-
-9. If `package.json` exists,
+7. If `package.json` exists,
    write the freshly bumped version string
    to `package.json`.
 
-10. If `package-lock.json` exists,
+8. If `package-lock.json` exists,
     run `npm i`.
 
-11. If `npm-shrinkwrap.json` exists,
+9. If `npm-shrinkwrap.json` exists,
     run `npm shrinkwrap`.
 
-12. If `pnpm-lock.yaml` exists,
+10. If `pnpm-lock.yaml` exists,
     run `pnpm i`.
 
-13. If `yarn.lock` exists,
+11. If `yarn.lock` exists,
     run `yarn`.
 
-14. If `setup.py` exists,
+12. If `setup.py` exists,
     write the freshly bumped version string
     to `setup.py`.
 
-15. If `Cargo.toml` exists,
+13. If `Cargo.toml` exists,
     write the freshly bumped version string
     to `Cargo.toml`.
 
-16. If `Cargo.lock` exists,
+14. If `go.mod` exists,
     write the freshly bumped version string
-    to `Cargo.lock`.
+    to `go.mod`.
 
-17. If a change log is detected,
+15. If a change log is detected,
     write a summary of the changes
     to the change log.
     It will recognise any of the following file names:
@@ -134,7 +126,7 @@ in order:
 
     * `HISTORY`
 
-18. Commit all changes
+16. Commit all changes
     made by the preceding steps.
 
 17. If `Cargo.toml` exists,
@@ -142,7 +134,7 @@ in order:
     If it fails,
     the release is aborted.
 
-18. Tag the release
+18. Tag the repo
     with the freshly bumped version string.
 
 ## What doesn't it do?

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "please-release-me",
-  "version": "2.1.6",
+  "version": "3.1.0",
   "description": "Let me go!",
   "author": "Phil Booth <pmbooth@gmail.com> (https://philbooth.me/)",
   "license": "MIT",

package/release.sh

@@ -1,49 +1,83 @@
 #!/bin/sh
 
-LAST_TAG=`git describe --tags --abbrev=0`
-COMMITS=`git log $LAST_TAG..HEAD --pretty=oneline`
+LAST_TAG=$(git describe --tags --abbrev=0)
+COMMITS=$(git log "$LAST_TAG..HEAD" --pretty=oneline)
 
-if [ "$COMMITS" = "" ]; then
-  echo "Release aborted: I see no work."
+if [ "$1" = "--notest" ]; then
+  TEST=false
+else
+  TEST=true
+fi
+
+if [ -f go.mod ]; then
+  IS_GO=true
+fi
+
+if [ -f package.json ]; then
+  IS_NODE=true
+fi
+
+if [ -f setup.py ]; then
+  IS_PYTHON=true
+fi
+
+if [ -f Cargo.toml ]; then
+  IS_RUST=true
+fi
+
+abort() {
+  echo "Release aborted: $1"
   exit 1
+}
+
+if [ "$COMMITS" = "" ]; then
+  abort "I see no work"
 fi
 
-grep '^\s*"lint":' package.json > /dev/null 2>&1
-if [ $? -eq 0 ]; then
-  npm run lint
-  if [ $? -ne 0 ]; then
-    echo "Release aborted: Lint failed."
-    exit 1
+if [ "$IS_GO" ]; then
+  if ! go vet ./...; then
+    abort "go vet failed"
   fi
 fi
 
-grep '^\s*"test":' package.json > /dev/null 2>&1
-if [ $? -eq 0 ]; then
-  npm t
-  if [ $? -ne 0 ]; then
-    echo "Release aborted: Tests failed."
-    exit 1
+if grep '^\s*"lint":' package.json > /dev/null 2>&1; then
+  if ! npm run lint; then
+    abort "npm run lint failed"
   fi
 fi
 
-grep '^\s*"minify":' package.json > /dev/null 2>&1
-if [ $? -eq 0 ]; then
-  npm run minify
-  if [ $? -ne 0 ]; then
-    echo "Release aborted: Minification failed."
-    exit 1
+if [ "$TEST" = "true" ]; then
+  if [ "$IS_GO" ]; then
+    if ! go test ./...; then
+      abort "go test failed"
+    fi
   fi
+
+  if grep '^\s*"minify":' package.json > /dev/null 2>&1; then
+    if ! npm t; then
+      abort "npm test failed"
+    fi
+  fi
+
+  if [ "$IS_RUST" ]; then
+    if ! cargo t; then
+      abort "cargo test failed"
+    fi
+  fi
+
 fi
 
-if [ -f Cargo.toml ]; then
-  cargo t
+if grep '^\s*"minify":' package.json > /dev/null 2>&1; then
+  if ! npm run minify; then
+    abort "npm run minify failed"
+  fi
 fi
 
 while read -r COMMIT; do
-  HASH=`echo "$COMMIT" | cut -d ' ' -f 1`
-  MESSAGE=`echo "$COMMIT" | cut -d ':' -f 2- | awk '{$1=$1};1'`
-  TYPE=`echo "$COMMIT" | cut -d ' ' -f 2 | awk '{$1=$1};1' | cut -d ':' -f 1 | cut -d '(' -f 1 | awk '{$1=$1};1'`
-  AREA=`echo "$COMMIT" | cut -d '(' -f 2 | cut -d ')' -f 1 | awk '{$1=$1};1'`
+  HASH=$(echo "$COMMIT" | cut -d ' ' -f 1)
+  MESSAGE=$(echo "$COMMIT" | cut -d ':' -f 2- | awk '{$1=$1};1')
+  TYPE=$(echo "$COMMIT" | cut -d ' ' -f 2 | awk '{$1=$1};1' | cut -d ':' -f 1 | cut -d '(' -f 1 | awk '{$1=$1};1')
+  AREA=$(echo "$COMMIT" | cut -d '(' -f 2 | cut -d ')' -f 1 | awk '{$1=$1};1')
 
   if [ "$AREA" = "$COMMIT" ]; then
     AREA=""
@@ -95,9 +129,11 @@ while read -r COMMIT; do
       OTHER_SUMMARY="$OTHER_SUMMARY\n* $AREA$MESSAGE ($HASH)"
       ;;
   esac
-done <<< "$COMMITS"
+done << EOF
+$COMMITS
+EOF
 
-if [ "$BUILD_TYPE" != "Major" -a "$BUILD_TYPE" != "Minor" ]; then
+if [ "$BUILD_TYPE" != "Major" ] && [ "$BUILD_TYPE" != "Minor" ]; then
   BUILD_TYPE="Patch"
 fi
 
@@ -127,64 +163,67 @@ fi
 
 SUMMARY="$BREAK_SUMMARY$FEAT_SUMMARY$FIX_SUMMARY$PERF_SUMMARY$REFACTOR_SUMMARY$OTHER_SUMMARY"
 
-MAJOR=`echo "$LAST_TAG" | cut -d '.' -f 1`
-MINOR=`echo "$LAST_TAG" | cut -d '.' -f 2`
-PATCH=`echo "$LAST_TAG" | cut -d '.' -f 3`
+MAJOR=$(echo "$LAST_TAG" | cut -d '.' -f 1)
+MINOR=$(echo "$LAST_TAG" | cut -d '.' -f 2)
+PATCH=$(echo "$LAST_TAG" | cut -d '.' -f 3)
 
 SED_FRIENDLY_LAST_TAG="$MAJOR\\.$MINOR\\.$PATCH"
 
 case $BUILD_TYPE in
   "Major")
-    MAJOR=`expr $MAJOR + 1`
+    MAJOR=$((MAJOR + 1))
     MINOR=0
     PATCH=0
     ;;
   "Minor")
-    MINOR=`expr $MINOR + 1`
+    MINOR=$((MINOR + 1))
     PATCH=0
     ;;
   "Patch")
-    PATCH=`expr $PATCH + 1`
+    PATCH=$((PATCH + 1))
     ;;
 esac
 
 NEW_TAG="$MAJOR.$MINOR.$PATCH"
 
-if [ -f bower.json ]; then
-  sed -i.release.bak -e "s/\"version\": \"$LAST_TAG\"/\"version\": \"$NEW_TAG\"/" bower.json
-  rm bower.json.release.bak
+if [ -f version.go ]; then
+  sed -i.release.bak -e "s/$SED_FRIENDLY_LAST_TAG/$NEW_TAG/g" version.go
+  rm version.go.release.bak
+  MODIFIED_FILES="$MODIFIED_FILES version.go"
 fi
 
-if [ -f component.json ]; then
-  sed -i.release.bak -e "s/\"version\": \"$LAST_TAG\"/\"version\": \"$NEW_TAG\"/" component.json
-  rm component.json.release.bak
-fi
-
-if [ -f package.json ]; then
+if [ "$IS_NODE" = "true" ]; then
   sed -i.release.bak -e "s/\"version\": \"$LAST_TAG\"/\"version\": \"$NEW_TAG\"/" package.json
   rm package.json.release.bak
-fi
-
-if [ -f package-lock.json ]; then
-  npm i
-
-  if [ -f npm-shrinkwrap.json ]; then
-    npm shrinkwrap
+  MODIFIED_FILES="$MODIFIED_FILES package.json"
+
+  if [ -f package-lock.json ]; then
+    npm i
+    MODIFIED_FILES="$MODIFIED_FILES package-lock.json"
+
+    if [ -f npm-shrinkwrap.json ]; then
+      npm shrinkwrap
+      MODIFIED_FILES="$MODIFIED_FILES npm-shrinkwrap.json"
+    fi
+  elif [ -f pnpm-lock.yaml ]; then
+    pnpm i
+    MODIFIED_FILES="$MODIFIED_FILES pnpm-lock.yaml"
+  elif [ -f yarn.lock ]; then
+    yarn
+    MODIFIED_FILES="$MODIFIED_FILES yarn.lock"
   fi
-elif [ -f pnpm-lock.yaml ]; then
-  pnpm i
-elif [ -f yarn.lock ]; then
-  yarn
 fi
 
-if [ -f setup.py ]; then
+if [ "$IS_PYTHON" = "true" ]; then
   sed -i.release.bak -e "s/$SED_FRIENDLY_LAST_TAG/$NEW_TAG/g" setup.py
   rm setup.py.release.bak
+  MODIFIED_FILES="$MODIFIED_FILES setup.py"
 fi
 
-if [ -f Cargo.toml ]; then
+if [ "$IS_RUST" = "true" ]; then
   sed -i.release.bak -e "s/$SED_FRIENDLY_LAST_TAG/$NEW_TAG/g" Cargo.toml
   rm Cargo.toml.release.bak
+  MODIFIED_FILES="$MODIFIED_FILES Cargo.toml"
 fi
 
 if [ -f CHANGELOG.md ]; then
@@ -211,15 +250,18 @@ if [ "$LOG" != "" ]; then
   TEMP="__please_release_me_$LOG.$NEW_TAG.tmp"
   awk "{ gsub(/^## $LAST_TAG$/, \"## $NEW_TAG\n\n$SUMMARY## $LAST_TAG\") }; { print }" "$LOG" > "$TEMP"
   mv "$TEMP" "$LOG"
+  MODIFIED_FILES="$MODIFIED_FILES $LOG"
 fi
 
-GIT_FRIENDLY_SUMMARY=`echo "$SUMMARY" | sed "s/#//g" | sed "s/^ //"`
+GIT_FRIENDLY_SUMMARY=$(echo "$SUMMARY" | sed "s/#//g" | sed "s/^ //")
 
-git commit -a -m "release: $NEW_TAG"
+# shellcheck disable=SC2086
+git add $MODIFIED_FILES
+git commit -m "release: $NEW_TAG"
 
 if [ -f Cargo.toml ]; then
   cargo package
 fi
 
-git tag -a "$NEW_TAG" -m "`echo \"$BUILD_TYPE release $NEW_TAG\\n\\n$GIT_FRIENDLY_SUMMARY\"`"
+git tag -a "$NEW_TAG" -m "$BUILD_TYPE release $NEW_TAG\n\n$GIT_FRIENDLY_SUMMARY"