https://github.com/jef/conventional-commits-release-action
🚀 Creates a release based on Conventional Commits
https://github.com/jef/conventional-commits-release-action
conventional-commits github-actions
Last synced: about 1 year ago
JSON representation
🚀 Creates a release based on Conventional Commits
- Host: GitHub
- URL: https://github.com/jef/conventional-commits-release-action
- Owner: jef
- License: mit
- Created: 2021-05-11T04:12:21.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T05:03:04.000Z (about 3 years ago)
- Last Synced: 2025-04-02T07:11:23.456Z (about 1 year ago)
- Topics: conventional-commits, github-actions
- Language: TypeScript
- Homepage:
- Size: 725 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# conventional-commits-release-action
Creates releases based on [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/).
## Usage
```yaml
name: Release
on:
push:
branches:
- main
jobs:
release:
name: Release code
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Release
uses: jef/conventional-commits-release-action@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
```
## Inputs
- `create-major`: Creates a major tag as well as Semantic Version. Default is `false`.
- `token` [**Required**]: Access token to the repository. Usually `${{ secrets.GITHUB_TOKEN }}`.
## Outputs
- `tag`: The tag that was created.
## Contributing
There are few npm tasks that will help you in building and packaging. All commands are prefaced by `npm run`.
- `build`: builds the action.
- `compile`: transpiles TypeScript.
- `clean`: removes `build` directory.
- `fix`: fixes lint and format issues.
- `lint`: runs linter and checks format issues.
- `start`: runs the action.
- `test`: tests the action.