This action will bump version, tag commit and generate a changelog with conventional commits.
- Required
github-token
: Github token. - Optional
git-message
: Commit message that is used when committing the changelog. - Optional
git-user-name
: The git user.name to use for the commit. DefaultConventional Changelog Action
- Optional
git-user-email
: The git user.email to use for the commit. Default[email protected]
- Optional
git-pull-method
: The git pull method used when pulling all changes from remote. Default--ff-only
- 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 providing'false'
no file will be generated / updated. - Optional
release-count
: Number of releases to preserve in changelog. Default5
, use0
to regenerate all. - Optional
version-file
: The path to the file that contains the version to bump. Default./package.json
. - Optional
version-path
: The place inside the version file to bump. Defaultversion
. - Optional
skip-on-empty
: Boolean to specify if you want to skip empty release (no-changelog generated). This case occured when you pushchore
commit withangular
for example. Default'true'
. - Optional
skip-version-file
: Do not update the version file. Default'false'
. - Optional
skip-commit
: Do not create a release commit. Default'false'
. - Optional
pre-commit
: Path to the pre-commit script file. No hook by default. - Optional
fallback-version
: The fallback version, if no older one can be detected, or if it is the first one. Default'0.1.0'
- Optional
config-file-path
: Path to the conventional changelog config file. If set, the preset setting will be ignored - Optional
pre-changelog-generation
: Path to the pre-changelog-generation script file. No hook by default.
Function in a specified file will be run right before the git-add-git-commit phase, when the next version is already known and a new changelog has been generated. You can run any chores across your repository that should be added and commited with the release commit.
Specified path could be relative or absolute. If it is relative, then it will be based on the GITHUB_WORKSPACE
path.
Script should:
- be a CommonJS module
- have a single export:
exports.preCommit = (props) => { /* ... */ }
- not have any return value
- be bundled (contain all dependencies in itself, just like the bundled webapp)
preCommit
function can be async
.
Following props will be passed to the function as a single parameter:
interface Props {
tag: string; // Next tag e.g. v1.12.3
version: string; // Next version e.g. 1.12.3
}
export function preCommit(props: Props): void {}
A bunch of useful environment variables are available to the script with process.env
. See docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables to learn more.
Function in a specified file will be run right before the changelog generation phase, when the next version is already known, but it was not used anywhere yet. It can be useful if you want to manually update version or tag.
Same restrictions as for the pre-commit hook, but exported functions names should be preVersionGeneration
for modifications to the version and preTagGeneration
for modifications to the git tag.
Following props will be passed to the function as a single parameter and same output is expected:
// Next version e.g. 1.12.3
export function preVersionGeneration(version: string): string {}
// Next tag e.g. v1.12.3
export function preTagGeneration(tag: string): string {}
A config file to define the conventional commit settings. Use it if you need to override values like issuePrefix
or issueUrlFormat
. If you set a config-file-path
, the preset
setting will be ignored. Therefore use an existing config and override the values you want to adjust.
example:
'use strict'
const config = require('conventional-changelog-conventionalcommits');
module.exports = config({
"issuePrefixes": ["TN-"],
"issueUrlFormat": "https://jira.example.com/browse/{{prefix}}{{id}}"
})
The specified path can be relative or absolute. If it is relative, then it will be based on the GITHUB_WORKSPACE
path.
Make sure to install all required packages in the workflow before executing this action.
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.skipped
: Boolean ('true'
or'false'
) specifying if this step have been skipped
Uses all the defaults
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
with:
github-token: ${{ secrets.github_token }}
Overwrite everything
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
with:
github-token: ${{ secrets.github_token }}
git-message: 'chore(release): {version}'
git-user-name: 'Awesome Changelog Action'
git-user-email: '[email protected]'
preset: 'angular'
tag-prefix: 'v'
output-file: 'MY_CUSTOM_CHANGELOG.md'
release-count: '10'
version-file: './my_custom_version_file.json' // or .yml, .yaml, .toml
version-path: 'path.to.version'
skip-on-empty: 'false'
skip-version-file: 'false'
skip-commit: 'false'
No file changelog
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
with:
github-token: ${{ secrets.github_token }}
output-file: "false"
Tag only
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
with:
github-token: ${{ secrets.github_token }}
skip-commit: "true"
Use a custom file for versioning
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
with:
github-token: ${{ secrets.github_token }}
version-file: "my-custom-file.yaml"
Use a pre-commit hook
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
with:
github-token: ${{ secrets.github_token }}
pre-commit: some/path/pre-commit.js
Github releases
- name: Conventional Changelog Action
id: changelog
uses: TriPSs/conventional-changelog-action@v3
with:
github-token: ${{ secrets.github_token }}
output-file: "false"
- name: Create Release
uses: actions/create-release@v1
if: ${{ steps.changelog.outputs.skipped == 'false' }}
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 }}
If you'd like to contribute to this project, all you need to do is clone and install act this project and run:
Make sure that
main: 'src/index.js'
is updated tomain: '../src/index.js'
inside theaction.yml
Note: The image used is 18 gb!
$ yarn install
# To run / test json versioning
$ act -j test-json -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
# To run / test git versioning
$ act -j test-git -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
# To run / test git fallback versioning
$ act -j test-git-fallback -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
# To run / test yaml versioning
$ act -j test-yaml -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
# To run / test toml versioning
$ act -j test-toml -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
# To run / test empty / new files test
$ act -j test-[json/toml/yaml]-[empty/new] -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
# To run pre-commit test
$ act -j test-pre-commit -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
# To run / multiple files test
$ act -j multiple-files -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
# To run / config file path test
$ act -j test-config-file-path -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
# To run pre-changelog-generation test
$ act -j test-pre-changelog-generation -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token
Conventional Changelog Action is MIT licensed.
If you have questions or issues, please open an issue!