mirror of
https://github.com/orhun/git-cliff-action.git
synced 2026-03-22 07:25:43 +08:00
docs(readme): add an example how to execute arbitrary git-cliff commands (#70)
* docs(readme): add an example how to execute arbitrary git-cliff commands Add an example to the README that shows how to execute arbitrary git-cliff commands in GitHub Actions via https://github.com/taiki-e/install-action. * Update README.md --------- Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
This commit is contained in:
35
README.md
35
README.md
@@ -27,7 +27,7 @@ This action generates a changelog based on your Git history using [git-cliff](ht
|
|||||||
>
|
>
|
||||||
> ```yaml
|
> ```yaml
|
||||||
> - name: Checkout
|
> - name: Checkout
|
||||||
> uses: actions/checkout@v4
|
> uses: actions/checkout@v6
|
||||||
> with:
|
> with:
|
||||||
> fetch-depth: 0
|
> fetch-depth: 0
|
||||||
> ```
|
> ```
|
||||||
@@ -54,7 +54,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ jobs:
|
|||||||
release_body: ${{ steps.git-cliff.outputs.content }}
|
release_body: ${{ steps.git-cliff.outputs.content }}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@@ -137,7 +137,7 @@ jobs:
|
|||||||
contents: write
|
contents: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@@ -163,6 +163,33 @@ jobs:
|
|||||||
|
|
||||||
Please note that you need to change the `<branch>` to the branch name that you want to push.
|
Please note that you need to change the `<branch>` to the branch name that you want to push.
|
||||||
|
|
||||||
|
#### Run arbitrary git-cliff commands
|
||||||
|
|
||||||
|
If you want more flexibility, you can install `git-cliff` via [taiki-e/install-action](https://github.com/taiki-e/install-action#example-workflow) and then run any `git-cliff` commands.
|
||||||
|
|
||||||
|
For example, you can use the command `git-cliff --bumped-version` to determine the next release version:
|
||||||
|
|
||||||
|
```yml
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Install git-cliff
|
||||||
|
uses: taiki-e/install-action@git-cliff
|
||||||
|
|
||||||
|
- name: Determine release version
|
||||||
|
run: |
|
||||||
|
release_version=$(git-cliff --bumped-version)
|
||||||
|
echo "Next release version is $release_version"
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Licensed under either of [Apache License Version 2.0](./LICENSE-APACHE) or [The MIT License](./LICENSE-MIT) at your option.
|
Licensed under either of [Apache License Version 2.0](./LICENSE-APACHE) or [The MIT License](./LICENSE-MIT) at your option.
|
||||||
|
|||||||
Reference in New Issue
Block a user