chore(project): add action files

This commit is contained in:
orhun
2021-06-18 00:27:35 +03:00
parent c83b82a967
commit 29b917f0c8
4 changed files with 90 additions and 0 deletions

34
README.md Normal file
View File

@@ -0,0 +1,34 @@
# git-cliff changelog generator action
This action generates a changelog based on your Git history using [git-cliff](https://github.com/orhun/git-cliff), on the fly!
## Usage
### Inputs
* `args`: Arguments to pass to git-cliff. Default `"-v"`
### Outputs
* `changelog`: The generated changelog.
### Examples
```
- name: Changelog Generator
uses: orhun/git-cliff-action@v1
with:
args: --verbose
```
## Credits
This action is based on [lycheeverse/lychee-action](https://github.com/lycheeverse/lychee-action) and uses [git-cliff](https://github.com/orhun/git-cliff).
## License
GNU General Public License ([v3.0](https://www.gnu.org/licenses/gpl.txt))
## Copyright
Copyright © 2021, [Orhun Parmaksız](mailto:orhunparmaksiz@gmail.com)