|
|
||
|---|---|---|
| .github | ||
| node_modules | ||
| src | ||
| .gitignore | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
| action.yml | ||
| package.json | ||
| yarn.lock | ||
README.md
Conventional Changelog action
This action will bump version, tag commit and generate a changelog with conventional commits.
Inputs
- Required
github-token: Github token. - Optional
git-message: Commit message that is used when committing the changelog. - Optional
preset: Preset that is used from conventional commits. Defaultangular. - Optional
tag-prefix: Prefix for the git tags. Defaultv. - Optional
output-file: File to output the changelog to. DefaultCHANGELOG.md, when providingfalseno file will be generated / updated. - Optional
release-count: Number of releases to preserve in changelog. Default5, use0to regenerate all. - Optional
package-json: The path to the package.json to use. Default./package.json.
Outputs
changelog: The generated changelog for the new version.clean_changelog: The generated changelog for the new version without the version name in it (Better for Github releases)version: The new version.tag: The name of the generated tag.
Example usages
Uses all the defaults
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v2
with:
github-token: ${{ secrets.github_token }}
Overwrite everything
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v2
with:
github-token: ${{ secrets.github_token }}
git-message: 'chore(release): {version}'
preset: 'angular'
tag-prefix: 'v'
output-file: 'CHANGELOG.md'
release-count: '5'
package-json: './package.json'
No file changelog
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v2
with:
github-token: ${{ secrets.github_token }}
output-file: 'false'
Github releases
- name: Conventional Changelog Action
id: changelog
uses: TriPSs/conventional-changelog-action@v2
with:
github-token: ${{ secrets.github_token }}
output-file: 'false'
- name: Create Release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.github_token }}
with:
tag_name: ${{ steps.changelog.outputs.tag }}
release_name: ${{ steps.changelog.outputs.tag }}
body: ${{ steps.changelog.outputs.clean_changelog }}