Skip to content

Commit

Permalink
docs: Clarify README content
Browse files Browse the repository at this point in the history
  • Loading branch information
Ahmed-Khaled-dev authored Aug 1, 2024
1 parent 2d48c47 commit 17c3086
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,22 @@ Generates accurate markdown/HTML release notes for GitHub releases and shows con
<a href="#how-to-build">How To Build</a>
</p>

<p align="center">
<img src="docs/images/release-notes-from-full-prs.png" alt="Markdown Release Notes From Pull Requests in Full Mode">
</p>

## Key Features
### 1. Generates markdown/HTML release notes for GitHub releases through a straightforward and customizable GitHub Actions user interface

<p align="center">
<img src="docs/images/release-notes-workflow-inputs.png" alt="Release Notes Generation GitHub Actions Workflow Inputs"><br>
<img src="docs/images/release-notes-from-full-prs.png" alt="Markdown Release Notes From Pull Requests in Full Mode" width="700">
<img src="docs/images/html-release-notes-from-full-prs.png" alt="HTML Release Notes From Pull Requests in Full Mode" width="700">
<img src="docs/images/release-notes-workflow-inputs.png" alt="Release Notes Generation GitHub Actions Workflow Inputs"><br><br>
Example Of Generating Release Notes in the <a href="https://github.com/synfig/synfig">Synfig Repo</a><br><br>
<strong>Generated Markdown Release Notes Inside The Release Description</strong><br><br>
<img src="docs/images/release-notes-from-full-prs.png" alt="Markdown Release Notes From Pull Requests in Full Mode" width="800"><br><br>
<strong>Generated HTML Release Notes Attached As An Asset To The Release</strong><br><br>
<img src="docs/images/html-release-notes-from-full-prs.png" alt="HTML Release Notes From Pull Requests in Full Mode" width="800">
</p>

### 2. Automatically shows contributors how their pull requests affect the release notes

<img src="docs/images/demo-pull-request.png" alt="Demo GitHub Pull Request" width="700">
<img src="docs/images/github-bot-comment-on-new-pr.png" alt="GitHub Bot Comment Showing The Contributor How This Demo Pull Request Affects The Release Notes" width="700"><br>
<img src="docs/images/github-bot-comment-on-new-pr.png" alt="GitHub Bot Comment Showing The Contributor How This Demo Pull Request Affects The Release Notes" width="700">
<img src="docs/images/demo-pull-request-edited.jpg" alt="Demo GitHub Pull Request After Editing The Description" width="700">
<img src="docs/images/github-bot-comment-on-edited-pr.png" alt="GitHub Bot Comment Showing The Contributor How His Edited Demo Pull Request Affects The Release Notes" width="700">

Expand Down Expand Up @@ -91,6 +90,7 @@ Generates accurate markdown/HTML release notes for GitHub releases and shows con
- name: Use Release Notes Manager Action
uses: Ahmed-Khaled-dev/release-notes-manager@v1
env:
# secrets.GITHUB_TOKEN is automatically generated by GitHub for each workflow run
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
action-type: release
Expand All @@ -113,7 +113,7 @@ Generates accurate markdown/HTML release notes for GitHub releases and shows con
**Notes**<br>
- In the "Release Notes Source" drop-down menu, you specify the source that the content of the release notes will be retrieved from, either from the commit messages of the commits that occurred between the two entered releases, or from the pull requests' titles and descriptions that were used to merge these commits
- The "Release Notes Mode" drop-down menu is used if you chose the source as pull requests, you can choose "Short" mode and generate release notes only from the pull requests' titles without the descriptions, or choose "Full" and generate release notes using the pull requests' titles and descriptions
- The "Release Notes Mode" drop-down menu is used if you choose the source as pull requests, you can select "Short" mode and generate release notes only from the pull requests' titles without the descriptions, or select "Full" and generate release notes using the pull requests' titles and descriptions
### 2. Showing contributors how their pull requests affect the release notes
Expand All @@ -135,6 +135,7 @@ Generates accurate markdown/HTML release notes for GitHub releases and shows con
- name: Use Release Notes Generator Action
uses: Ahmed-Khaled-dev/release-notes-manager@v1
env:
# secrets.GITHUB_TOKEN is automatically generated by GitHub for each workflow run
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
action-type: pr
Expand All @@ -143,7 +144,7 @@ Generates accurate markdown/HTML release notes for GitHub releases and shows con
github-repository: ${{ github.repository }}
```
That's it! Now automatically whenever a new pull request is created or edited, a GitHub bot will show the contributor how his pull request affects the release notes and will encourage him to improve his change description
That's it! Now automatically whenever a new pull request is created or edited, a GitHub bot will show the contributor how his pull request affects the release notes and will encourage him to improve his change description.
## How To Build
Expand Down

0 comments on commit 17c3086

Please sign in to comment.