- introduce preview screenshots for sample output, and a sample result
This commit is contained in:
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 174 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 131 KiB |
@@ -9,6 +9,10 @@
|
|||||||
... a GitHub action that builds your release notes fast, easy and exactly the way you want.
|
... a GitHub action that builds your release notes fast, easy and exactly the way you want.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src=".github/images/release_changelog_builder_collapsed.png"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://github.com/mikepenz/release-changelog-builder-action/actions">
|
<a href="https://github.com/mikepenz/release-changelog-builder-action/actions">
|
||||||
<img src="https://github.com/mikepenz/release-changelog-builder-action/workflows/CI/badge.svg"/>
|
<img src="https://github.com/mikepenz/release-changelog-builder-action/workflows/CI/badge.svg"/>
|
||||||
@@ -21,7 +25,7 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="#whats-included-">What's included 🚀</a> •
|
<a href="#whats-included-">What's included 🚀</a> •
|
||||||
<a href="#setup">Setup 🛠️</a> •
|
<a href="#setup">Setup 🛠️</a> •
|
||||||
<a href="#full-sample-%EF%B8%8F">Full Sample 🖥️</a> •
|
<a href="#full-sample-%EF%B8%8F">Sample 🖥️</a> •
|
||||||
<a href="#customization-%EF%B8%8F">Customization 🖍️</a> •
|
<a href="#customization-%EF%B8%8F">Customization 🖍️</a> •
|
||||||
<a href="#contribute-">Contribute 🧬</a> •
|
<a href="#contribute-">Contribute 🧬</a> •
|
||||||
<a href="#license">License 📓</a>
|
<a href="#license">License 📓</a>
|
||||||
@@ -114,6 +118,11 @@ on:
|
|||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<a href="https://github.com/mikepenz/release-changelog-builder-action/runs/1270879787"><img src=".github/images/release_changelog_builder_expanded.png"/></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Scroll to the bottom of the README to see a sample result changelog.
|
||||||
|
|
||||||
## Customization 🖍️
|
## Customization 🖍️
|
||||||
|
|
||||||
@@ -285,8 +294,9 @@ export GITHUB_TOKEN=your_personal_github_pat
|
|||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
Core parts of the PR fetching logic are based on [pull-release-notes](https://github.com/nblagoev/pull-release-notes)
|
- Core parts of the PR fetching logic are based on [pull-release-notes](https://github.com/nblagoev/pull-release-notes)
|
||||||
- Nikolay Blagoev - [GitHub](https://github.com/nblagoev/)
|
- Nikolay Blagoev - [GitHub](https://github.com/nblagoev/)
|
||||||
|
- [action-gh-release](https://github.com/softprops/action-gh-release) for a few great README ideas
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
@@ -310,3 +320,9 @@ All patches and changes applied to the original source are licensed under the Ap
|
|||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
See the License for the specific language governing permissions and
|
See the License for the specific language governing permissions and
|
||||||
limitations under the License.
|
limitations under the License.
|
||||||
|
|
||||||
|
## Sample result changelog
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<a href="https://github.com/mikepenz/release-changelog-builder-action/releases/tag/v0.9.0"><img src=".github/images/release_changelog_result.png"/></a>
|
||||||
|
</div>
|
||||||
|
|||||||
Reference in New Issue
Block a user