release_draft.yml

#
# Copyright 2021 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: 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
      from-tag-name:
        description: 'Name of the git tag from which to detect changes from. Default value: latest tag. Syntax: "v[0-9]+.[0-9]+.[0-9]+".'
        required: false

jobs:
  release-draft:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
        with:
          fetch-depth: 0
          persist-credentials: false

      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
        with:
          python-version: '3.13'

      - name: Check Format of Received Tag
        id: check-version-tag
        uses: AbsaOSS/version-tag-check@4145e48bf3f77a5afff2ec9afdd8afb6b53bce34
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          github-repository: ${{ github.repository }}
          version-tag: ${{ github.event.inputs.tag-name }}

      - name: Check Format of Received From Tag
        if: ${{ github.event.inputs.from-tag-name }}
        id: check-version-from-tag
        uses: AbsaOSS/version-tag-check@4145e48bf3f77a5afff2ec9afdd8afb6b53bce34
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          github-repository: ${{ github.repository }}
          version-tag: ${{ github.event.inputs.from-tag-name }}
          should-exist: true

      - name: Generate Release Notes
        id: generate_release_notes
        uses: AbsaOSS/generate-release-notes@B90223510d1704301a36a36f0d86a72a0e72f0cf
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag-name: ${{ github.event.inputs.tag-name }}
          from-tag-name: ${{ github.event.inputs.from-tag-name }}
          chapters: |
            - {"title": "Entries to skip 🚫", "label": "duplicate"}
            - {"title": "Entries to skip 🚫", "label": "invalid"}
            - {"title": "Entries to skip 🚫", "label": "wontfix"}
            - {"title": "Entries to skip 🚫", "label": "no RN"}
            - {"title": "Breaking Changes 💥", "label": "breaking change"}
            - {"title": "Security updates 👮", "label": "security"}
            - {"title": "New Features 🎉", "label": "enhancement"}
            - {"title": "Bugfixes 🛠", "label": "bug"}
            - {"title": "Epics 📖", "label": "epic"}
            - {"title": "Infrastructure ⚙️", "label": "infrastructure"}
            - {"title": "Silent-live 🤫", "label": "silent live"}
            - {"title": "Documentation 📜", "label": "documentation"}
          duplicity-scope: 'none'
          warnings: true
          skip-release-notes-labels: "no RN,duplicate,invalid,wontfix"
          print-empty-chapters: false
          row-format-issue: '_{title}_ {developers} in {number}'
          row-format-pr: '_{title}_ {developers} in {number}'
          row-format-link-pr: true
          hierarchy: true

      - name: Create and Push Tag (standalone)
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3
        with:
          script: |
            const tag = core.getInput('tag-name')
            const ref = `refs/tags/${tag}`;
            const sha = context.sha; // The SHA of the commit to tag
            const tagMessage = `${tag} released by GitHub Action`;

            const tagObject = await github.rest.git.createTag({
              owner: context.repo.owner,
              repo: context.repo.repo,
              tag: tag,
              message: tagMessage,
              object: sha,
              type: 'commit',
              tagger: {
                name: context.actor,
                email: `${context.actor}@users.noreply.github.com`,
                date: new Date().toISOString()
              }
            });

            await github.rest.git.createRef({
              owner: context.repo.owner,
              repo: context.repo.repo,
              ref: ref,
              sha: tagObject.data.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@b4309332981a82ec1c5618f44dd2e27cc8bfbfda
        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