feat: Add concurrency workflow implementation guide

labs/concurrency.md

@@ -0,0 +1,144 @@
+# How to Implement This Workflow
+
+[Documentation](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/control-the-concurrency-of-workflows-and-jobs)
+
+1. **Navigate to Your Repository**  
+   Open your GitHub repository where you want to add the workflow.
+
+2. **Create the Workflow Directory**  
+   Ensure there is a `.github/workflows` directory in the root of your repository. If it does not exist, create it.
+
+3. **Add a New Workflow File**  
+   Inside the `.github/workflows` directory, create a new file. You can name it, for example, `concurency-lab.yml`.
+
+4. **Set the Workflow Name**  
+   At the top of the file, specify a name for the workflow, such as “Concurrency Demo”.
+
+5. **Configure the Trigger**  
+   Set the workflow to be triggered manually using the `workflow_dispatch` event.
+
+6. **Define Concurrency Settings**  
+   Add a concurrency group that uses the workflow name and reference. Enable the option to cancel any in-progress runs if a new one starts.
+
+<details>
+  <summary>Solution</summary>
+
+```YAML
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true 
+```
+
+</details>
+
+7. **Add the 'upload-tree' Job**  
+   Add a job that runs on the latest Ubuntu runner. Include step to check out the repository, list the files in the repository and add it to a `.txt` file, group the output with the `::group::` workflow command. Add a step to upload the `.txt` file as an artifact and simulate work by pausing for 10 seconds.
+
+<details>
+  <summary>Solution</summary> 
+
+```YAML
+    - name: List files in the repository
+      run: |
+        echo "::group::The repository ${{ github.repository }} contains the following files"
+        tree > tree.txt
+        cat tree.txt
+        echo "::endgroup::"
+
+    - name: Upload tree output
+      uses: actions/upload-artifact@v4
+      with:
+        name: tree-output
+        path: tree.txt
+```
+
+</details>
+
+8. **Add the 'add-summary' Job**  
+   Add a second job that also runs on the latest Ubuntu runner. Download the artifact with the `.txt` file, Include a step to simulate work by pausing for 10 seconds, and then add a [workflow summary](https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries/) to the job showing the contents of the `.txt` file.
+
+<details>
+    <summary>Solution</summary>
+
+```YAML
+      - name: Download tree output
+        uses: actions/download-artifact@v4
+        with:
+          name: tree-output
+
+      - name: Add job summary with tree output
+        run: |
+          echo "### Job completed! :rocket:" >> $GITHUB_STEP_SUMMARY
+          echo '### Project Directory Tree' >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          cat tree.txt >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+```
+
+</details>
+
+9. **Save and Commit**  
+   Save the workflow file and commit it to your repository.
+
+10. **Run the Workflow**  
+    Go to the Actions tab in your GitHub repository, select the workflow, and trigger it twice in quick succession. Observe that only the jobs from the last triggered workflow will run, as earlier runs will be cancelled due to the concurrency settings.
+
+<details>
+  <summary>Solution</summary>
+
+```YAML
+name: Concurrency Demo
+
+on:
+    workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  upload-tree:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 
+        uses: actions/checkout@v4
+
+      - name: List files in the repository
+        run: |
+          echo "::group::The repository ${{ github.repository }} contains the following files"
+          tree > tree.txt
+          cat tree.txt
+          echo "::endgroup::"
+
+      - name: Upload tree output
+        uses: actions/upload-artifact@v4
+        with:
+          name: tree-output
+          path: tree.txt
+
+      - name: Simulate work
+        run: sleep 10  
+
+  add-summary:
+    runs-on: ubuntu-latest
+    needs: upload-tree
+    steps:
+      - name: Download tree output
+        uses: actions/download-artifact@v4
+        with:
+          name: tree-output
+
+      - name: Simulate work
+        run: sleep 10
+
+      - name: Add job summary with tree output
+        run: |
+          echo "### Job completed! :rocket:" >> $GITHUB_STEP_SUMMARY
+          echo '### Project Directory Tree' >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+          cat tree.txt >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+```
+
+</details>
+