docs: Update README
parent
7684c0e755
commit
7b3a082685
41
README.md
41
README.md
|
@ -8,16 +8,23 @@ This action will bump version, tag commit and generate a changelog with conventi
|
|||
- **Optional** `git-message`: Commit message that is used when committing the changelog.
|
||||
- **Optional** `preset`: Preset that is used from conventional commits. Default `angular`.
|
||||
- **Optional** `tag-prefix`: Prefix for the git tags. Default `v`.
|
||||
- **Optional** `output-file`: File to output the changelog to. Default `CHANGELOG.md`.
|
||||
- **Optional** `output-file`: File to output the changelog to. Default `CHANGELOG.md`, when providing `false` no file will be generated / updated.
|
||||
- **Optional** `release-count`: Number of releases to preserve in changelog. Default `5`, use `0` to 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
|
||||
```yaml
|
||||
- name: Conventional Changelog Action
|
||||
uses: TriPSs/conventional-changelog-action@v2.1.0
|
||||
uses: TriPSs/conventional-changelog-action@v2
|
||||
with:
|
||||
github-token: ${{ secrets.github_token }}
|
||||
```
|
||||
|
@ -25,7 +32,7 @@ Uses all the defaults
|
|||
Overwrite everything
|
||||
```yaml
|
||||
- name: Conventional Changelog Action
|
||||
uses: TriPSs/conventional-changelog-action@v2.1.0
|
||||
uses: TriPSs/conventional-changelog-action@v2
|
||||
with:
|
||||
github-token: ${{ secrets.github_token }}
|
||||
git-message: 'chore(release): {version}'
|
||||
|
@ -35,3 +42,31 @@ Overwrite everything
|
|||
release-count: '5'
|
||||
package-json: './package.json'
|
||||
```
|
||||
|
||||
No file changelog
|
||||
```yaml
|
||||
- name: Conventional Changelog Action
|
||||
uses: TriPSs/conventional-changelog-action@v2
|
||||
with:
|
||||
github-token: ${{ secrets.github_token }}
|
||||
output-file: 'false'
|
||||
```
|
||||
|
||||
Github releases
|
||||
```yaml
|
||||
- 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 }}
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue