Changed 'skip-on-empty' default in README
parent
ca16f2de01
commit
e6c2b51e1f
23
README.md
23
README.md
|
@ -15,7 +15,7 @@ This action will bump version, tag commit and generate a changelog with conventi
|
|||
- **Optional** `release-count`: Number of releases to preserve in changelog. Default `5`, use `0` 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. Default `version`.
|
||||
- **Optional** `skip-on-empty`: Boolean to specify if you want to skip empty release (no-changelog generated). This case occured when you push `chore` commit with `angular` for example. Default `'false'`.
|
||||
- **Optional** `skip-on-empty`: Boolean to specify if you want to skip empty release (no-changelog generated). This case occured when you push `chore` commit with `angular` for example. Default `'true'`.
|
||||
- **Optional** `skip-version-file`: Do not update the version file. Default `'false'`.
|
||||
- **Optional** `skip-commit`: Do create a release commit. Default `'false'`.
|
||||
- **Optional** `pre-commit`: Path to the pre-commit script file. No hook by default.
|
||||
|
@ -29,6 +29,7 @@ This action will bump version, tag commit and generate a changelog with conventi
|
|||
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
|
||||
|
@ -96,7 +97,7 @@ No file changelog
|
|||
uses: TriPSs/conventional-changelog-action@v3
|
||||
with:
|
||||
github-token: ${{ secrets.github_token }}
|
||||
output-file: 'false'
|
||||
output-file: "false"
|
||||
```
|
||||
|
||||
Tag only
|
||||
|
@ -106,7 +107,7 @@ Tag only
|
|||
uses: TriPSs/conventional-changelog-action@v3
|
||||
with:
|
||||
github-token: ${{ secrets.github_token }}
|
||||
skip-commit: 'true'
|
||||
skip-commit: "true"
|
||||
```
|
||||
|
||||
Use a custom file for versioning
|
||||
|
@ -116,7 +117,7 @@ Use a custom file for versioning
|
|||
uses: TriPSs/conventional-changelog-action@v3
|
||||
with:
|
||||
github-token: ${{ secrets.github_token }}
|
||||
version-file: 'my-custom-file.yaml'
|
||||
version-file: "my-custom-file.yaml"
|
||||
```
|
||||
|
||||
Use a pre-commit hook
|
||||
|
@ -137,24 +138,26 @@ Github releases
|
|||
uses: TriPSs/conventional-changelog-action@v3
|
||||
with:
|
||||
github-token: ${{ secrets.github_token }}
|
||||
output-file: 'false'
|
||||
skip-on-empty: 'true'
|
||||
output-file: "false"
|
||||
|
||||
- name: Create Release
|
||||
uses: actions/create-release@v1
|
||||
if: ${{ steps.changelog.outputs.skipped == 'false' }}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.github_token }}
|
||||
GITHUB_TOKEN: ${{ secrets.github_token }}
|
||||
with:
|
||||
tag_name: ${{ steps.changelog.outputs.tag }}
|
||||
release_name: ${{ steps.changelog.outputs.tag }}
|
||||
body: ${{ steps.changelog.outputs.clean_changelog }}
|
||||
tag_name: ${{ steps.changelog.outputs.tag }}
|
||||
release_name: ${{ steps.changelog.outputs.tag }}
|
||||
body: ${{ steps.changelog.outputs.clean_changelog }}
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
If you'd like to contribute to this project, all you need to do is clone and install [act](https://github.com/nektos/act) this project and run:
|
||||
|
||||
> Make sure that `main: 'src/index.js'` is updated to `main: '../src/index.js'` inside the `action.yml`
|
||||
> Note: The image used is 18 gb!
|
||||
|
||||
```shell
|
||||
$ yarn install
|
||||
|
||||
|
|
Loading…
Reference in New Issue