diff --git a/docs/RELEASE.md b/docs/RELEASE.md new file mode 100644 index 00000000..63b41974 --- /dev/null +++ b/docs/RELEASE.md @@ -0,0 +1,26 @@ +# Releasing new version + +## Beta development + +Instructions for releasing beta packages on the `dev` branch + +### Steps + +1. Check out `dev` +1. Pull latest +1. Run script to bump versions and push changes to new branch `npmRelease` + + ```bash + ./scripts/npmVersionBumpPrerelease.sh + ``` + +1. Open PR, get reviews +1. Merge PR +1. Check out `dev` +1. Run script + + ```bash + scripts/tagBranchForRelease.sh + ``` + +1. Travis will automatically release to npm diff --git a/package-lock.json b/package-lock.json index b5ab78e3..3e81f791 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "serverless-azure-functions", - "version": "1.0.0-3", + "version": "1.0.0-4", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 720da473..744b556f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "serverless-azure-functions", - "version": "1.0.0-3", + "version": "1.0.0-4", "description": "Provider plugin for the Serverless Framework v1.x which adds support for Azure Functions.", "license": "MIT", "main": "./lib/index.js", diff --git a/scripts/npmPublishBeta.sh b/scripts/npmVersionBumpPrerelease.sh similarity index 100% rename from scripts/npmPublishBeta.sh rename to scripts/npmVersionBumpPrerelease.sh diff --git a/scripts/tagBranchForRelease.sh b/scripts/tagBranchForRelease.sh new file mode 100755 index 00000000..6afa93e8 --- /dev/null +++ b/scripts/tagBranchForRelease.sh @@ -0,0 +1,16 @@ +#/bin/sh +set -eu + +RELEASE_BRANCH=$1 +ON_BRANCH=$(git rev-parse --abbrev-ref HEAD) + +if [[ $ON_BRANCH != $RELEASE_BRANCH ]]; then + echo "You're on ${ON_BRANCH}. Please checkout out $RELEASE_BRANCH before running this script" + exit 1 +fi + +echo "getting latest" +git pull +PACKAGE_VERSION=$(node -p -e "require('./package.json').version") +git tag $PACKAGE_VERSION +git push origin $PACKAGE_VERSION