Skip to content

Commit

Permalink
Improve Doc - Add User Impact chapter (#127)
Browse files Browse the repository at this point in the history
- Sub-chapters added with example and description.
  • Loading branch information
miroslavpojer authored Jan 14, 2025
1 parent 6cbebbf commit d91634d
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
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

0 comments on commit d91634d

Please sign in to comment.