Fixes #5 (#6)

andyfeller · web-flow · commit c6c3137baa80 · 2022-08-12T10:22:03.000-07:00
* Initial pass cleaning up workflows

* Adding workflow step echoing

* Fixing logic error with step

* Fixing instructions setting up step 5

* Clarify the use of draft for step 4

* Undoing step 5 instruction changes
diff --git a/.github/script/STEP b/.github/script/STEP
@@ -1 +1 @@
-1
+0
diff --git a/.github/workflows/0-start.yml b/.github/workflows/0-start.yml
@@ -18,22 +18,30 @@ permissions:
   pull-requests: write
 
 jobs:
-  setup:
-    name: Setup
-    uses: ./.github/workflows/get-current-step.yml
+  get_current_step:
+    name: Check current step number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - id: get_step
+        run: |
+          echo '::echo::on'
+          echo "::set-output name=current_step::$(cat ./.github/script/STEP)"
+    outputs:
+      current_step: ${{ steps.get_step.outputs.current_step }}
 
   on_start:
     name: On start
-    needs: setup
+    needs: get_current_step
 
     # We will only run this action when:
     # 1. This repository isn't the template repository
     # 2. The STEP is currently '0' (see update-step.sh)
     # 3. This is the first workflow run on the repository
     # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
     # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
-    if: ${{ !github.event.repository.is_template
-        && needs.setup.outputs.current_step == 0 }}
+    if: ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 0 }}
 
     # We'll run Ubuntu for performance instead of Mac or Windows
     runs-on: ubuntu-latest
diff --git a/.github/workflows/1-create-beta-release.yml b/.github/workflows/1-create-beta-release.yml
@@ -16,16 +16,29 @@ permissions:
   contents: write
 
 jobs:
+  get_current_step:
+    name: Check current step number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - id: get_step
+        run: |
+          echo '::echo::on'
+          echo "::set-output name=current_step::$(cat ./.github/script/STEP)"
+    outputs:
+      current_step: ${{ steps.get_step.outputs.current_step }}
+
   on_beta_release_created:
     name: On beta release created
+    needs: get_current_step
 
     # We will only run this action when:
     # 1. This repository isn't the template repository
     # 1. The tag for the published release is v0.9
     # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
     # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
-    if: ${{ !github.event.repository.is_template 
-        && github.ref_name == 'v0.9' }}
+    if: ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 1 && github.ref_name == 'v0.9' }}
 
     # We'll run Ubuntu for performance instead of Mac or Windows
     runs-on: ubuntu-latest
diff --git a/.github/workflows/2-feature-added-to-release.yml b/.github/workflows/2-feature-added-to-release.yml
@@ -18,21 +18,29 @@ permissions:
   contents: write
 
 jobs:
-  setup:
-    name: Setup
-    uses: ./.github/workflows/get-current-step.yml
+  get_current_step:
+    name: Check current step number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - id: get_step
+        run: |
+          echo '::echo::on'
+          echo "::set-output name=current_step::$(cat ./.github/script/STEP)"
+    outputs:
+      current_step: ${{ steps.get_step.outputs.current_step }}
 
   on_feature_added:
     name: On feature added
-    needs: setup
+    needs: get_current_step
 
     # We will only run this action when:
     # 1. This repository isn't the template repository
     # 2. The STEP is currently '2'
     # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
     # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
-    if: ${{ !github.event.repository.is_template 
-        && needs.setup.outputs.current_step == 2 }}
+    if: ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 2 }}
 
     # We'll run Ubuntu for performance instead of Mac or Windows
     runs-on: ubuntu-latest
diff --git a/.github/workflows/3-release-pr-opened.yml b/.github/workflows/3-release-pr-opened.yml
@@ -1,4 +1,4 @@
-name: Check step 3, release pull request opened
+name: Check step 3, Release pull request opened
 
 # This step triggers after 2-feature-added-to-release.yml
 # This step sets STEP to 4
@@ -16,16 +16,29 @@ permissions:
   contents: write
 
 jobs:
+  get_current_step:
+    name: Check current step number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - id: get_step
+        run: |
+          echo '::echo::on'
+          echo "::set-output name=current_step::$(cat ./.github/script/STEP)"
+    outputs:
+      current_step: ${{ steps.get_step.outputs.current_step }}
+
   on_release_pr_opened:
     name: On release pull request opened
+    needs: get_current_step
 
     # We will only run this action when:
     # 1. This repository isn't the template repository
     # 2. The pull request head branch is 'release-v1.0' 
     # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
     # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
-    if: ${{ !github.event.repository.is_template 
-        && github.head_ref == 'release-v1.0' }}
+    if: ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 3 && github.head_ref == 'release-v1.0' }}
 
     # We'll run Ubuntu for performance instead of Mac or Windows
     runs-on: ubuntu-latest
diff --git a/.github/workflows/4-release-notes-and-merge.yml b/.github/workflows/4-release-notes-and-merge.yml
@@ -1,4 +1,4 @@
-name: Check step 4, generate release notes and merge
+name: Check step 4, Generate release notes and merge
 
 # This step triggers after 3-release-pr-opened.yml
 # This step sets STEP to 5
@@ -20,18 +20,30 @@ permissions:
   contents: write
 
 jobs:
+  get_current_step:
+    name: Check current step number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - id: get_step
+        run: |
+          echo '::echo::on'
+          echo "::set-output name=current_step::$(cat ./.github/script/STEP)"
+    outputs:
+      current_step: ${{ steps.get_step.outputs.current_step }}
+
   on_release_merged:
     name: On release-v1.0 merged
+    needs: get_current_step
 
     # We will only run this action when:
     # 1. This repository isn't the template repository
     # 2. The pull request was closed through a merge
     # 3. The pull request head branch is release-v1.0
     # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
     # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
-    if: ${{ !github.event.repository.is_template 
-        && github.event.pull_request.merged == true
-        && github.head_ref == 'release-v1.0'}}
+    if: ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 4 && github.event.pull_request.merged == true && github.head_ref == 'release-v1.0'}}
 
     # We'll run Ubuntu for performance instead of Mac or Windows
     runs-on: ubuntu-latest
diff --git a/.github/workflows/5-finalize-release.yml b/.github/workflows/5-finalize-release.yml
@@ -1,4 +1,4 @@
-name: Check step 5, commit a hotfix
+name: Check step 5, Commit hotfix
 
 # This step triggers after 4-release-notes-and-merge.yml
 # This step sets STEP to 6
@@ -17,16 +17,29 @@ permissions:
   pull-requests: write
 
 jobs:
+  get_current_step:
+    name: Check current step number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - id: get_step
+        run: |
+          echo '::echo::on'
+          echo "::set-output name=current_step::$(cat ./.github/script/STEP)"
+    outputs:
+      current_step: ${{ steps.get_step.outputs.current_step }}
+
   on_release_published:
     name: On release v1.0 published
+    needs: get_current_step
 
     # We will only run this action when:
     # 1. This repository isn't the template repository
     # 1. The tag for the published release is v1.0.0
     # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
     # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
-    if: ${{ !github.event.repository.is_template 
-      && github.ref_name == 'v1.0.0' }}
+    if: ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 5 && github.ref_name == 'v1.0.0' }}
 
     # We'll run Ubuntu for performance instead of Mac or Windows
     runs-on: ubuntu-latest
diff --git a/.github/workflows/6-commit-hotifx.yml b/.github/workflows/6-commit-hotifx.yml
@@ -19,18 +19,30 @@ permissions:
   contents: write
 
 jobs:
+  get_current_step:
+    name: Check current step number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - id: get_step
+        run: |
+          echo '::echo::on'
+          echo "::set-output name=current_step::$(cat ./.github/script/STEP)"
+    outputs:
+      current_step: ${{ steps.get_step.outputs.current_step }}
+
   on_hotfix_merged:
     name: On hotfix-v1.0.1 merged
+    needs: get_current_step
 
     # We will only run this action when:
     # 1. This repository isn't the template repository
     # 2. The pull request was closed through a merge
     # 3. The pull request head branch is hotfix-v1.0.1
     # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
     # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
-    if: ${{ !github.event.repository.is_template 
-        && github.event.pull_request.merged == true
-        && github.head_ref == 'hotfix-v1.0.1'}}
+    if: ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 6 && github.event.pull_request.merged == true && github.head_ref == 'hotfix-v1.0.1' }}
 
     # We'll run Ubuntu for performance instead of Mac or Windows
     runs-on: ubuntu-latest
diff --git a/.github/workflows/7-create-hotfix-release.yml b/.github/workflows/7-create-hotfix-release.yml
@@ -1,4 +1,4 @@
-name: Check step 7, create release v1.0.1
+name: Check step 7, Create release v1.0.1
 
 # This step triggers after 6-commit-hotifx.yml
 # This step sets STEP to x
@@ -16,16 +16,29 @@ permissions:
   contents: write
 
 jobs:
+  get_current_step:
+    name: Check current step number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - id: get_step
+        run: |
+          echo '::echo::on'
+          echo "::set-output name=current_step::$(cat ./.github/script/STEP)"
+    outputs:
+      current_step: ${{ steps.get_step.outputs.current_step }}
+
   on_hotfix_release_published:
     name: On hotfix release v1.0.1 published
+    needs: get_current_step
 
     # We will only run this action when:
     # 1. This repository isn't the template repository
     # 1. The tag for the published release is v1.0.1
     # Reference https://docs.github.com/en/actions/learn-github-actions/contexts
     # Reference https://docs.github.com/en/actions/learn-github-actions/expressions
-    if: ${{ !github.event.repository.is_template
-        && github.ref_name == 'v1.0.1' }}
+    if: ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 7 && github.ref_name == 'v1.0.1' }}
 
     # We'll run Ubuntu for performance instead of Mac or Windows
     runs-on: ubuntu-latest
diff --git a/.github/workflows/get-current-step.yml b/.github/workflows/get-current-step.yml
diff --git a/README.md b/README.md
@@ -165,7 +165,7 @@ Let's make a new pull request comparing the `release-v1.0` branch to the `main`
 1. To the top right of the description text box, click **Generate release notes**
 1. Review the release notes in the text box and customize the content if desired
 1. Set the _Target_ branch back to the `main`, as this is the branch you want to create your tag on once the release branch is merged
-1. Click **Save draft**
+1. Click **Save draft**, as you will publish this release in the next step
 
 You can now [merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge) your pull request!
 
@@ -210,9 +210,8 @@ Now let's change our recently automated release from _draft_ to _latest release_
 1. In a separate tab, go to the **Releases** page for this repository
     - To reach this page, click the **Code** tab at the top of your repository. Then, find the navigation bar below the repository description, and click the **Releases** heading link
 1. Click the **Edit** button next to your draft release
-1. Click the **Draft a new release** button
 1. Ensure the _Target_ branch is set to `main`
-1. Click **Publish release**
+1. Click **Update release**
 1. Wait about 20 seconds then refresh this page for the next step
 
 </details>
