Skip to content
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.

Sign up for GitHub

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

Improve Doc - Add User Impact chapter #127

Merged
merged 1 commit into from
Jan 14, 2025
Merged

Improve Doc - Add User Impact chapter #127

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,11 +421,26 @@ Tag is created after successful release notes generation to avoid manual removin

See the [example of workflow](./examples/release_draft.yml).

#### Impact to Users
The users can trigger the workflow manually by clicking the "Run workflow" button in the Actions tab. The workflow will create a release tag and a draft release based on the release notes generated by the action.

This workflow replaces the manual process of creating a release tag and draft release, saving time and ensuring consistency in the release process.

### Check Release Notes Presence - in Pull Request Description
This workflow checks that every pull request includes release notes in the description.

See the [example of workflow](./examples/check_pr_release_notes.yml).

#### Impact to Users
The users are expected to provide the release notes in the pull request body. See example:
```markdown
Release Notes: .... also valid: ## Release Notes:
- 1st line of PR's release notes
- 2nd line of PR's release notes
```

This section can be placed anywhere in the pull request body. The action will search for the release notes based on the provided title text. _Hint:_ The title can be chapter name, the Markdown format tags are ignored.

## Contribution Guidelines

We welcome contributions to the Generate Release Notes Action! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.
Expand Down
Loading