Renders a changelog for a release or something like that.
Path for long changelog to export into
Default: .changelog_long.md
Path for short changelog to export into
Default: .changelog_short.md
Format for long changelog
Documentation: https://git-scm.com/docs/pretty-formats
Default: %w(1000)* %cd %an <%ae>%n%w(1000,0,2)- %s%n
Format for short changelog
Documentation: https://git-scm.com/docs/pretty-formats
Default: %w(200,0,2)- %s (%an <%ae>)
Ref to start changelog from
Default: last tag
Ref to start changelog from
Default: HEAD
Header before the actual changelog
Default: # Changelog
Whether to print out rendered changelogs or not
Default: false
long_changelog_filename- Rendered long changelog filenameshort_changelog_filename- Rendered short changelog filename
---
name: Release
on:
push:
branches:
- "*"
jobs:
changelog_render:
name: Render a changelog
runs-on: ubuntu-latest
outputs:
long_changelog_filename: ${{ steps.changelog_render.outputs.long_changelog_filename }}
short_changelog_filename: ${{ steps.changelog_render.outputs.short_changelog_filename }}
steps:
- name: Check out code
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Generate changelog
id: changelog_render
uses: reinvented-stuff/changelog-render-action@master
with:
long_changelog_export_filename: ".long_changelog.md"
short_changelog_export_filename: ".short_changelog.md"
print_out_changelogs: true
...
* Sun Jun 12 2022 Pavel Kim <[email protected]>
- [Fix] Double changelog output after a copy-paste
* Sun Jun 12 2022 Pavel Kim <[email protected]>
- [Fix] Mixed up bash and github variable reference formats
* Sun Jun 12 2022 Pavel Kim <[email protected]>
- [Fix] Input not defined at all and raises an error when referenced if not passed when calling
* Sun Jun 12 2022 Pavel Kim <[email protected]>
- [Change] Version bump
* Sun Jun 12 2022 Pavel Kim <[email protected]>
- [Change] Even more improved readability in readme
* Sun Jun 12 2022 Pavel Kim <[email protected]>
- [Change] Improved readability, added all input defaults in readme
* Sun Jun 12 2022 Pavel Kim <[email protected]>
- [Change] Github Workflow now uses changelog-render-action instead of manual implementation
* Sun Jun 12 2022 Pavel Kim <[email protected]>
- [Add] Initial state
- [Fix] Double changelog output after a copy-paste (Pavel Kim <[email protected]>)
- [Fix] Mixed up bash and github variable reference formats (Pavel Kim <[email protected]>)
- [Fix] Input not defined at all and raises an error when referenced if not passed when calling (Pavel Kim <[email protected]>)
- [Change] Version bump (Pavel Kim <[email protected]>)
- [Change] Even more improved readability in readme (Pavel Kim <[email protected]>)
- [Change] Improved readability, added all input defaults in readme (Pavel Kim <[email protected]>)
- [Change] Github Workflow now uses changelog-render-action instead of manual implementation (Pavel Kim <[email protected]>)
- [Add] Initial state (Pavel Kim <[email protected]>)