-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e3abbfc
commit 94a26a0
Showing
5 changed files
with
34 additions
and
170 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,61 +14,14 @@ jobs: | |
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 | ||
- uses: actions/[email protected] | ||
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." | ||
python-version: '3.11' | ||
|
||
- 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 | ||
- name: Check presence of release notes in PR description | ||
uses: AbsaOSS/[email protected] | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
github-repository: ${{ github.repository }} | ||
pr-number: ${{ github.event.number }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,62 +7,6 @@ on: | |
required: true | ||
|
||
jobs: | ||
check-tag: | ||
runs-on: {your-runner} | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
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 }} | ||
|
||
release-draft: | ||
needs: check-tag | ||
runs-on: {your-runner} | ||
|
@@ -71,11 +15,22 @@ jobs: | |
- uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
persist-credentials: false | ||
|
||
- uses: actions/[email protected] | ||
with: | ||
python-version: '3.11' | ||
|
||
- name: Check format of received tag | ||
id: check-version-tag | ||
uses: AbsaOSS/[email protected] | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
github-repository: ${{ github.repository }} | ||
branch: 'master' | ||
version-tag: ${{ github.event.inputs.tag-name }} | ||
|
||
- name: Generate Release Notes | ||
id: generate_release_notes | ||
uses: AbsaOSS/[email protected] | ||
|
@@ -101,8 +56,6 @@ jobs: | |
|
||
warnings: true | ||
print-empty-chapters: true | ||
chapters-to-pr-without-issue: true | ||
|
||
|
||
- name: Create and Push Tag | ||
uses: actions/github-script@v7 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,3 @@ | ||
coverage==7.5.2 | ||
pytest==7.4.3 | ||
pytest-cov==5.0.0 | ||
pytest-mock==3.14.0 | ||
|