From c0ae5ee6fb3327d818a1f8af11b511ceff64eadc Mon Sep 17 00:00:00 2001 From: miroslavpojer Date: Mon, 21 Oct 2024 13:24:22 +0200 Subject: [PATCH] #31 - Release PoC (#49) - Updated workflow for Release Notes check in PR description. - Update workflow for Release draft generation. --- .../check_pr_release_note_comment.yml | 44 ------ .github/workflows/check_pr_release_notes.yml | 87 +++++++++++ .github/workflows/release_draft.yml | 147 +++++++++++------- 3 files changed, 175 insertions(+), 103 deletions(-) delete mode 100644 .github/workflows/check_pr_release_note_comment.yml create mode 100644 .github/workflows/check_pr_release_notes.yml diff --git a/.github/workflows/check_pr_release_note_comment.yml b/.github/workflows/check_pr_release_note_comment.yml deleted file mode 100644 index 23c53fe..0000000 --- a/.github/workflows/check_pr_release_note_comment.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Check Release Notes in PR comment - -on: - pull_request: - types: [opened, synchronize, reopened, edited, labeled, unlabeled] - branches: [ master ] - -jobs: - check-release-notes-comments: - runs-on: ubuntu-latest - name: Release Notes Comment Check - steps: - - name: Fetch all PR comments - id: get-comments - uses: actions/github-script@v7 - with: - github-token: ${{secrets.GITHUB_TOKEN}} - script: | - const issueNumber = context.issue.number; - const repoName = context.repo.repo; - const repoOwner = context.repo.owner; - - const comments = await github.rest.issues.listComments({ - owner: repoOwner, - repo: repoName, - issue_number: issueNumber, - }); - - return comments.data.map(comment => comment.body); - - - name: Check for 'Release Notes' in comments - uses: actions/github-script@v7 - with: - script: | - const comments = ${{ steps.get-comments.outputs.result }}; - const releaseNotesRegex = /release notes/i; - const hasReleaseNotes = comments.some(comment => releaseNotesRegex.test(comment)); - - if (!hasReleaseNotes) { - console.log('No "Release notes" found in PR comments'); - core.setFailed('No "Release notes" found in PR comments') - } else { - console.log('"Release notes" found in comments'); - } diff --git a/.github/workflows/check_pr_release_notes.yml b/.github/workflows/check_pr_release_notes.yml new file mode 100644 index 0000000..0ce19ed --- /dev/null +++ b/.github/workflows/check_pr_release_notes.yml @@ -0,0 +1,87 @@ +# +# Copyright 2024 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 PR Release Notes in Description + +on: + pull_request: + types: [opened, synchronize, reopened, edited, labeled, unlabeled] + branches: [ master ] + +env: + SKIP_LABEL: 'no RN' + RLS_NOTES_TAG_REGEX: 'Release Notes:' + +jobs: + check-release-notes: + runs-on: ubuntu-latest + + steps: + - 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) : []; + + if (labels.includes("${{ env.SKIP_LABEL }}")) { + console.log("Skipping release notes check because '${{ env.SKIP_LABEL }}' label is present."); + core.setOutput("skip_check", 'true'); + core.setOutput("pr_body", ""); + 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 SKIP_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 -q '${{ env.RLS_NOTES_TAG_REGEX }}'; then + echo "Error: release notes tag not found in pull request description. Has to adhere to format '${{ env.RLS_NOTES_TAG_REGEX }}'." + exit 1 + fi + + # Extract text after "Release Notes:" line + TEXT_BELOW_RELEASE_NOTES_TAG=$(echo "$PR_BODY" | sed -n '/${{ env.RLS_NOTES_TAG_REGEX }}/,$p' | tail -n +2) + + # Check if there's a bullet list (lines starting with '-', '+' or '*') + if ! echo "$TEXT_BELOW_RELEASE_NOTES_TAG" | grep -qE '^\s*[-+*]\s+.+$'; then + echo "Error: No bullet list found under release notes tag." + exit 1 + fi diff --git a/.github/workflows/release_draft.yml b/.github/workflows/release_draft.yml index 3d3c745..ec5e60e 100644 --- a/.github/workflows/release_draft.yml +++ b/.github/workflows/release_draft.yml @@ -1,3 +1,19 @@ +# +# Copyright 2024 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: Release - create draft release on: workflow_dispatch: @@ -7,7 +23,7 @@ on: required: true jobs: - tag: + check-tag: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -20,96 +36,109 @@ jobs: 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/' - }); - console.log(`Existing tags: ${refs.map(ref => ref.ref.replace('refs/tags/', '')).join(', ')}`); - - const latestTag = refs.sort((a, b) => new Date(b.object.date) - new Date(a.object.date))[0].ref.replace('refs/tags/', ''); - console.log(`Latest tag: ${latestTag}`); + # - 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 }} - 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); + release-draft: + needs: check-tag + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 - if (!isValid) { - core.setFailed('New tag is not one version higher than the latest tag'); - return; - } + - uses: actions/setup-python@v5.1.1 + with: + python-version: '3.11' + - name: Generate Release Notes + id: generate_release_notes + uses: AbsaOSS/generate-release-notes@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: tag-name: ${{ github.event.inputs.tag-name }} + chapters: '[ + {"title": "No entry 🚫", "label": "duplicate"}, + {"title": "No entry 🚫", "label": "invalid"}, + {"title": "No entry 🚫", "label": "wontfix"}, + {"title": "No entry 🚫", "label": "no RN"}, + {"title": "Breaking Changes 💥", "label": "breaking-change"}, + {"title": "New Features 🎉", "label": "enhancement"}, + {"title": "New Features 🎉", "label": "feature"}, + {"title": "Bugfixes 🛠", "label": "bug"}, + {"title": "Infrastructure ⚙️", "label": "infrastructure"}, + {"title": "Silent-live 🤫", "label": "silent-live"}, + {"title": "Documentation 📜", "label": "documentation"} + ]' + warnings: true + verbose: true - - name: Create and push tag + - 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 }} - release: - needs: tag - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - ref: refs/tags/${{ github.event.inputs.tag-name }} - - - name: Generate release notes - id: generate_release_notes - uses: AbsaOSS/generate-release-notes@master - 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": "feature"}, - {"title": "New Features 🎉", "label": "enhancement"}, - {"title": "Bugfixes 🛠", "label": "bug"} - ] - warnings: true - - - name: Create draft release + - 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.releaseNotes }} + body: ${{ steps.generate_release_notes.outputs.release-notes }} tag_name: ${{ github.event.inputs.tag-name }} draft: true prerelease: false