Skip to content

Commit

Permalink
- Fix review comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
miroslavpojer committed Dec 9, 2024
1 parent 4d9a1bd commit 69d2474
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Generate Release Notes action is dedicated to enhance the quality and organizati
- **Required**: Yes

### `chapters`
- **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.
- **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.
- **Required**: Yes

### `row-format-issue`
Expand Down Expand Up @@ -140,7 +140,7 @@ Add the following step to your GitHub workflow (in example are used non-default
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag-name: "v0.1.0"
chapters:
chapters: |
- {"title": "Breaking Changes 💥", "label": "breaking-change"},
- {"title": "New Features 🎉", "label": "enhancement"},
- {"title": "New Features 🎉", "label": "feature"},
Expand All @@ -156,7 +156,7 @@ Add the following step to your GitHub workflow (in example are used non-default
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag-name: "v0.1.0"
chapters:
chapters: |
- {"title": "Breaking Changes 💥", "label": "breaking-change"},
- {"title": "New Features 🎉", "label": "enhancement"},
- {"title": "New Features 🎉", "label": "feature"},
Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ inputs:
description: 'The tag name of the release to generate notes for.'
required: true
chapters:
description: 'Yaml array defining chapters and corresponding labels for categorization.'
description: 'An YAML array defining chapters and corresponding labels for categorization.'
required: false
default: ''
default: []
duplicity-scope:
description: 'Allow duplicity of issue lines in chapters. Scopes: custom, service, both, none.'
required: false
Expand Down

0 comments on commit 69d2474

Please sign in to comment.