From d91634d90820d8af1686cd0e7643f2dc7534736d Mon Sep 17 00:00:00 2001 From: miroslavpojer Date: Tue, 14 Jan 2025 08:42:08 +0100 Subject: [PATCH] Improve Doc - Add User Impact chapter (#127) - Sub-chapters added with example and description. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 9edd26ca..fc48bc75 100644 --- a/README.md +++ b/README.md @@ -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.