Update release process description in readme and add hotfix release action (#472)

Author: rroppolo

.github/workflows/create-new-release.yml

@@ -1,11 +1,6 @@
 name: "Create new release"
 
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: 'The version you want to release.'
-        required: true
+on: workflow_dispatch
 
 jobs:
   create-new-release:
@@ -16,6 +11,8 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
+        with:
+          node-version: '14.17.4'
       - run: npm config set "@fortawesome:registry" https://npm.fontawesome.com/ &&
           npm config set "//npm.fontawesome.com/:_authToken" $FONTAWESOME_NPM_AUTH_TOKEN
       - run: yarn install

.github/workflows/prepare-hotfix.yml

@@ -0,0 +1,59 @@
+name: "Prepare hotfix"
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'The version you want to release.'
+        required: true
+
+jobs:
+  prepare-hotfix:
+    name: Prepare hotfix
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14.17.4'
+
+      - name: Create hotfix branch
+        run: git checkout -b hotfix/${{ github.event.inputs.version }}
+
+      - name: Initialize mandatory git config
+        uses: fregante/setup-git-user@v1
+
+      - name: Bump version in package.json
+        run: yarn version --new-version ${{ github.event.inputs.version }} --no-git-tag-version
+
+      - name: Commit manifest files
+        id: make-commit
+        run: |
+          git add package.json
+          git commit --message "Prepare hotfix ${{ github.event.inputs.version }}"
+
+          echo "::set-output name=commit::$(git rev-parse HEAD)"
+
+      - name: Publish hotfix branch
+        run: git push origin hotfix/${{ github.event.inputs.version }}
+
+      - name: Merge hotfix into main branch
+        uses: thomaseizinger/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          head: hotfix/${{ github.event.inputs.version }}
+          base: main
+          title: Merge hotfix/${{ github.event.inputs.version }} into main branch
+
+      - name: Merge hotfix into develop branch
+        uses: thomaseizinger/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          head: hotfix/${{ github.event.inputs.version }}
+          base: develop
+          title: Merge hotfix/${{ github.event.inputs.version }} into develop branch
+

.github/workflows/prepare-release.yml

@@ -8,14 +8,16 @@ on:
         required: true
 
 jobs:
-  create-new-release:
-    name: Create new release
+  prepare-release:
+    name: Prepare release
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
       - uses: actions/setup-node@v1
+        with:
+          node-version: '14.17.4'
 
       - name: Create release branch
         run: git checkout -b release/${{ github.event.inputs.version }}

.github/workflows/release.yml

@@ -143,9 +143,33 @@ Once your pull request has been approved by all parties, you may begin the merge
 * Run `yarn test` to ensure tests are passing.
 * Click the Squash and merge button on your pull request and edit your commit message to a concise description of your changes.
 
-## Release steps
+## Release process
 
-This package uses [Semantic versioning](https://semver.org/), which requires version numbers in MAJOR.MINOR.PATCH format. Any breaking changes to the API require an update to the MAJOR version. Backwards compatible changes only require an update to the MINOR version. Hotfixes and patches need only update the PATCH version. Once you have commits ready to bundle you may begin the release process:
+This repository follows the [git flow release process](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).
+* Each new feature branch uses develop as its parent branch and is merged back into develop upon completion.
+* Each new hotfix branch uses main as its parent branch and is merged directly into main.
+
+This package uses [Semantic versioning](https://semver.org/), which requires version numbers in MAJOR.MINOR.PATCH format. Any breaking changes to the API require an update to the MAJOR version. Backwards compatible changes only require an update to the MINOR version. Hotfixes and patches need only update the PATCH version.
+
+To create a new release off of the current develop:
+* Run the "Prepare release" github action which will
+  * Create a new release branch off of the latest develop and increment package.json
+  * Create a pull request of the release branch against main
+  * Create a pull request of the release branch against develop
+  * From there the developer can merge the PRs via github
+* Run the "Create new release" github action which will build the project and create a new release off of the latest main
+
+To create a patch release for a hotfix off the current main:
+* Run the "Prepare hotfix" github action which will
+  * Create a hotfix off the latest main and increment package.json
+  * Create a pull request of the hotfix branch against main
+  * Create a pull request of the release branch against develop
+  * From there the developer can merge the PRs via github
+* Run the "Create new release" github action which will build the project and create a new release off of the latest main
+
+## Manual Release steps
+
+If you are not able to or choose not to use the github actions described above, the following is the process to manually create a new release. Once you have commits ready to bundle you may begin the release process:
 * Update the "version" field in package.json.
 * Run `yarn build` to compile the source files and write out to the lib directory.
 * Run `npm pack` to archive all of the source files. Note: you can run `npm pack --dry-run` to see a list of files that will be included in the package. This is useful to double check a new component is being added or to see the size of the package/individual files.