-
Notifications
You must be signed in to change notification settings - Fork 1
Generate Release Notes workflow #146
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
miroslavpojer
merged 7 commits into
master
from
feature/145-implement-generate-release-notes-workflow
May 27, 2026
+141
−0
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
c4b30b1
Generate Release Notes workflow implemented to the project
tmikula-dev f419230
Fix of correct using the provided tag name.
tmikula-dev 6492916
Fix of correct using the provided tag name.
tmikula-dev 67f4214
Merge remote-tracking branch 'origin/feature/145-implement-generate-r…
tmikula-dev ae92127
Adding the concurrency to the workflow
tmikula-dev 544a1a2
Adding the extra configuration.
tmikula-dev b360083
Adding permissions and making tag verified.
tmikula-dev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <!-- What problem does it solve or what feature does it add? --> | ||
| ## Overview | ||
|
|
||
| <!-- Summarize the key changes for release notes. --> | ||
| ## Release Notes | ||
| - TBD: 1st item of release notes | ||
| - TBD: 2nd item of release notes | ||
|
|
||
| <!-- Add attached issue that this PR solves. --> | ||
| ## Related | ||
| Closes #issue_number |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| name: Check PR Release Notes | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, edited, labeled, unlabeled] | ||
| branches: [ master ] | ||
|
|
||
| concurrency: | ||
| group: release-notes-check-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| check-release-notes: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 | ||
| with: | ||
| python-version: '3.14' | ||
|
|
||
| - name: Check presence of release notes in PR body | ||
| uses: AbsaOSS/release-notes-presence-check@8e586b26a5e27f899ee8590a5d988fd4780a3dbf | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| github-repository: ${{ github.repository }} | ||
| pr-number: ${{ github.event.number }} | ||
| title: "## [Rr]elease [Nn]otes" | ||
| skip-labels: 'no RN' | ||
| skip-placeholders: 'TBD' |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| 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 | ||
|
|
||
| permissions: | ||
| contents: write | ||
| issues: read | ||
| pull-requests: read | ||
|
|
||
| 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.14' | ||
|
|
||
| - name: Check format of received target 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@da535383f54a6532adb84e88d3b6e5c7236132df | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| release-notes-title: "## [Rr]elease [Nn]otes" | ||
| tag-name: ${{ github.event.inputs.tag-name }} | ||
| from-tag-name: ${{ github.event.inputs.from-tag-name }} | ||
| chapters: | | ||
| - { title: New Features 🎉, label: enhancement, order: 20 } | ||
| - { title: Bugfixes 🛠, label: bug, order: 30 } | ||
| - { title: Dependencies ⚙️, label: dependencies, order: 50 } | ||
| - { title: No entry 🚫, label: duplicate, hidden: true, order: 99 } | ||
| warnings: true | ||
| print-empty-chapters: false | ||
| row-format-issue: '{type}: {number} _{title}_ by {developers} in {pull-requests}' | ||
| row-format-pr: '{number} _{title}_ by {developers}' | ||
|
|
||
| - name: Create and push tag (standalone) | ||
| uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 | ||
| env: | ||
| TAG_NAME: ${{ github.event.inputs.tag-name }} | ||
| with: | ||
| script: | | ||
| const tag = process.env.TAG_NAME; | ||
| const ref = `refs/tags/${tag}`; | ||
| const sha = context.sha; | ||
|
|
||
| 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 }} | ||
|
|
||
| - 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 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.