#86 - Create local examples of workflows proposals

.github/workflows/check_pr_release_notes.yml

@@ -0,0 +1,85 @@
+#
+# Copyright 2023 ABSA Group Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: Check Release Notes in PR description
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited, labeled, unlabeled]
+    branches: [ master ]
+
+jobs:
+  check-release-notes:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get Pull Request Info
+        id: pr_info
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const pr_number = context.payload.pull_request.number;
+            const pr = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: pr_number
+            });
+            const labels = pr.data.labels ? pr.data.labels.map(label => label.name) : [];
+
+            // Check if "skip-release-notes-check" label is present
+            if (labels.includes("skip-release-notes-check")) {
+              console.log("Skipping release notes check because 'skip-release-notes-check' label is present.");
+              core.setOutput("skip_check", 'true');
+              return;
+            }
+
+            const pr_body = pr.data.body;
+            if (!pr_body) {
+              core.setFailed("Pull request description is empty.");
+              core.setOutput("pr_body", "");
+              core.setOutput("skip_check", 'false');
+              return;
+            }
+            core.setOutput("pr_body", pr_body);
+            core.setOutput("skip_check", 'false');
+            return;
+
+      - name: Skip check if 'no-release-notes' label is present
+        if: steps.pr_info.outputs.skip_check == 'true'
+        run: echo "Skipping release notes validation."
+
+      - name: Check for 'Release notes:' and bullet list
+        if: steps.pr_info.outputs.skip_check == 'false'
+        run: |
+          # Extract the body from the previous step
+          PR_BODY="${{ steps.pr_info.outputs.pr_body }}"
+
+          # Check if "Release notes:" exists
+          if ! echo "$PR_BODY" | grep -qi 'release notes:'; then
+            echo "Error: 'Release notes:' not found in pull request description."
+            exit 1
+          fi
+
+          # Extract text after "Release notes:" line
+          RELEASE_NOTES=$(echo "$PR_BODY" | sed -n '/[Rr]elease.*[Nn]otes/,$p' | tail -n +2)
+
+          # Check if there's a bullet list (lines starting with '-' or '*')
+          if ! echo "$RELEASE_NOTES" | grep -qE '^\s*[-*]\s+.+$'; then
+            echo "Error: No bullet list found under 'Release notes:'."
+            exit 1
+          fi

README.md

@@ -393,6 +393,22 @@ export INPUT_GITHUB_TOKEN=$(printenv <your-env-token-var>)
 python3 ./<path-to-action-project-root>/main.py
 ```
 
+## GitHub Workflow Examples
+GitHub Actions enable automating key parts of your development process.
+
+### Create Release Tag & Draft Release - By Workflow Dispatch
+This workflow automates the creation of a release tag and a draft release, triggered manually via a workflow dispatch.
+Tag is created after successful release notes generation to avoid manual removing of the tag if the release notes are not generated due to wrong configuration.
+
+See the [example of workflow](./examples/release_draft.yml).
+
+### Check Release Notes Presence - in Pull Request Description 
+This workflow checks that every pull request includes release notes in the description.
+- The check can be skipped by using the `skip-release-notes` label.
+- The check is searching a `[Rr]elease [Nn]otes:` strings in the PR description.
+
+See the [example of workflow](./examples/check_pr_release_notes.yml).
+
 ## Contribution Guidelines
 
 We welcome contributions to the Generate Release Notes Action! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.

examples/check_pr_release_notes.yml

@@ -0,0 +1,69 @@
+name: Check Release Notes in PR description
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited, labeled, unlabeled]
+    branches: [ master ]
+
+jobs:
+  check-release-notes:
+    runs-on: {your-runner}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get Pull Request Info
+        id: pr_info
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const pr_number = context.payload.pull_request.number;
+            const pr = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: pr_number
+            });
+            const labels = pr.data.labels ? pr.data.labels.map(label => label.name) : [];
+
+            // Check if "skip-release-notes-check" label is present
+            if (labels.includes("skip-release-notes-check")) {
+              console.log("Skipping release notes check because 'skip-release-notes-check' label is present.");
+              core.setOutput("skip_check", 'true');
+              return;
+            }
+
+            const pr_body = pr.data.body;
+            if (!pr_body) {
+              core.setFailed("Pull request description is empty.");
+              core.setOutput("pr_body", "");
+              core.setOutput("skip_check", 'false');
+              return;
+            }
+            core.setOutput("pr_body", pr_body);
+            core.setOutput("skip_check", 'false');
+            return;
+
+      - name: Skip check if 'no-release-notes' label is present
+        if: steps.pr_info.outputs.skip_check == 'true'
+        run: echo "Skipping release notes validation."
+
+      - name: Check for 'Release notes:' and bullet list
+        if: steps.pr_info.outputs.skip_check == 'false'
+        run: |
+          # Extract the body from the previous step
+          PR_BODY="${{ steps.pr_info.outputs.pr_body }}"
+
+          # Check if "Release notes:" exists
+          if ! echo "$PR_BODY" | grep -qi 'release notes:'; then
+            echo "Error: 'Release notes:' not found in pull request description."
+            exit 1
+          fi
+
+          # Extract text after "Release notes:" line
+          RELEASE_NOTES=$(echo "$PR_BODY" | sed -n '/[Rr]elease.*[Nn]otes/,$p' | tail -n +2)
+
+          # Check if there's a bullet list (lines starting with '-' or '*')
+          if ! echo "$RELEASE_NOTES" | grep -qE '^\s*[-*]\s+.+$'; then
+            echo "Error: No bullet list found under 'Release notes:'."
+            exit 1
+          fi

examples/release_draft.yml

@@ -0,0 +1,121 @@
+name: Release - create draft release
+on:
+  workflow_dispatch:
+    inputs:
+      tag-name:
+        description: 'Name of git tag to be created, and then draft release created. Syntax: "v[0-9]+.[0-9]+.[0-9]+".'
+        required: true
+
+jobs:
+  check-tag:
+    runs-on: {your-runner}
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+
+      - name: Validate format of received tag
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const newTag = core.getInput('tag-name');
+            const regex = /^v[0-9]+\.[0-9]+\.[0-9]+$/;
+
+            if (!regex.test(newTag)) {
+              core.setFailed('Tag does not match the required format "v[0-9]+.[0-9]+.[0-9]+"');
+              return;
+            }
+          tag-name: ${{ github.event.inputs.tag-name }}
+
+      - name: Check tag's correct version increment
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const newTag = core.getInput('tag-name');
+
+            // get latest tag
+            const { data: refs } = await github.rest.git.listMatchingRefs({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: 'tags/'
+            });
+
+            if (refs.length === 0) {
+              // No existing tags, so any new tag is valid
+              console.log('No existing tags found. Any new tag is considered valid.');
+              return;
+            }
+
+            const latestTag = refs.sort((a, b) => new Date(b.object.date) - new Date(a.object.date))[0].ref.replace('refs/tags/', '');
+            const latestVersion = latestTag.replace('v', '').split('.').map(Number);
+            const newVersion = newTag.replace('v', '').split('.').map(Number);
+
+            // check tag's correct version increase
+            const isValid = (latestVersion[0] === newVersion[0] && latestVersion[1] === newVersion[1] && newVersion[2] === latestVersion[2] + 1) ||
+              (latestVersion[0] === newVersion[0] && newVersion[1] === latestVersion[1] + 1 && newVersion[2] === 0) ||
+              (newVersion[0] === latestVersion[0] + 1 && newVersion[1] === 0 && newVersion[2] === 0);
+
+            if (!isValid) {
+              core.setFailed('New tag is not one version higher than the latest tag');
+              return;
+            }
+
+          tag-name: ${{ github.event.inputs.tag-name }}
+
+  generate-release-notes:
+    needs: check-tag
+    runs-on: {your-runner}
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+
+      - uses: actions/[email protected]
+        with:
+          python-version: '3.11'
+
+      - name: Generate Release Notes
+        id: generate_release_notes
+        uses: AbsaOSS/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag-name: ${{ github.event.inputs.tag-name }}
+          chapters: '[
+            {"title": "Breaking Changes 💥", "label": "breaking-change"},
+            {"title": "New Features 🎉", "label": "enhancement"},
+            {"title": "New Features 🎉", "label": "feature"},
+            {"title": "Bugfixes 🛠", "label": "bug"}
+          ]'
+          skip-release-notes-label: 'ignore-in-release'     # changing default value of label
+          verbose: true
+
+      - name: Create and Push Tag
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const tag = core.getInput('tag-name')
+            const ref = `refs/tags/${tag}`;
+            const sha = context.sha; // The SHA of the commit to tag
+
+            await github.rest.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: ref,
+              sha: sha
+            });
+
+            console.log(`Tag created: ${tag}`);
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          tag-name: ${{ github.event.inputs.tag-name }}
+
+      - name: Create Draft Release
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          name: ${{ github.event.inputs.tag-name }}
+          body: ${{ steps.generate_release_notes.outputs.release-notes }}
+          tag_name: ${{ github.event.inputs.tag-name }}
+          draft: true
+          prerelease: false