Skip to content

Commit 6cbebbf

Browse files
Added missing information about new input "from tag" and its usage. (#126)
1 parent 96baa6a commit 6cbebbf

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
- [Enable skipping of release notes for specific issues using label](#enable-skipping-of-release-notes-for-specific-issues-using-label)
1616
- [Enable Service Chapters](#enable-service-chapters)
1717
- [Showing Duplicity Lines In Chapters](#showing-duplicity-lines-in-chapters)
18+
- [Define "From Tag" Name](#define-from-tag-name)
1819
- [Get Started](#get-started)
1920
- [Run Static Code Analysis](#running-static-code-analysis)
2021
- [Run Black Tool Locally](#run-black-tool-locally)
@@ -50,6 +51,11 @@ Generate Release Notes action is dedicated to enhance the quality and organizati
5051
- **Description**: The name of the tag for which you want to generate release notes. This should be the same as the tag name used in the release workflow.
5152
- **Required**: Yes
5253

54+
### `from-tag-name`
55+
- **Description**: The name of the tag from which you want to generate release notes.
56+
- **Required**: No
57+
- **Default**: ``
58+
5359
### `chapters`
5460
- **Description**: An YAML array defining chapters and corresponding labels for categorization. Each chapter should have a title and a label matching your GitHub issues and PRs.
5561
- **Required**: Yes
@@ -139,7 +145,8 @@ Add the following step to your GitHub workflow (in example are used non-default
139145
env:
140146
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
141147
with:
142-
tag-name: "v0.1.0"
148+
tag-name: "v0.2.0"
149+
from-tag-name: "v0.1.0"
143150
chapters: |
144151
- {"title": "Breaking Changes 💥", "label": "breaking-change"}
145152
- {"title": "New Features 🎉", "label": "enhancement"}
@@ -155,7 +162,8 @@ Add the following step to your GitHub workflow (in example are used non-default
155162
env:
156163
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
157164
with:
158-
tag-name: "v0.1.0"
165+
tag-name: "v0.2.0"
166+
from-tag-name: "v0.1.0"
159167
chapters: |
160168
- {"title": "Breaking Changes 💥", "label": "breaking-change"}
161169
- {"title": "New Features 🎉", "label": "enhancement"}
@@ -254,6 +262,11 @@ Duplicity lines in `custom` chapters can point to potential issues with wrong la
254262

255263
By setting `duplicity-icon` you can customize the icon used to indicate duplicity issue lines in the release notes. Icon will be placed at the beginning of the line. The duplicity icon is visible from **second** occurrence of the issue in the selected scope.
256264

265+
### Define "From Tag" Name
266+
By setting the `from-tag-name` option, the action will generate release notes from the specified tag to the tag defined in the `tag-name` option. This feature is helpful for generating release notes for a specific range of tags.
267+
268+
The final interval is time-based. The `published-at` or `created-at` timestamp of the previous release or repository creation date, if it is the first release, is used as the starting point. The previous release is determined to be the previous semantic version tag.
269+
257270
## Get Started
258271

259272
Clone the repository and navigate to the project directory:

examples/release_draft.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ jobs:
4646

4747
- name: Generate Release Notes
4848
id: generate_release_notes
49-
uses: AbsaOSS/generate-release-notes@v0.3.0
49+
uses: AbsaOSS/generate-release-notes@v0.6.0
5050
env:
5151
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5252
with:

0 commit comments

Comments
 (0)