orhun/git-cliff-action
1
0
Fork 0
mirror of https://github.com/orhun/git-cliff-action.git synced 2026-03-24 00:15:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): update examples

Browse Source
This commit is contained in:
orhun
2021-07-02 01:19:16 +03:00
parent 30c8d01aac
commit f33ebb9c7f
1 changed files with 69 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
README.md
View File

@@ -24,22 +24,27 @@ This action generates a changelog based on your Git history using [git-cliff](ht
The following example fetches the whole Git history (`fetch-depth: 0`), generates a changelog in `./CHANGELOG.md`, and prints it out. The following example fetches the whole Git history (`fetch-depth: 0`), generates a changelog in `./CHANGELOG.md`, and prints it out.
```yml ```yml
- name: Checkout jobs:
uses: actions/checkout@v2 changelog:
with: name: Generate changelog
fetch-depth: 0 runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Generate a changelog - name: Generate a changelog
uses: orhun/git-cliff-action@v1 uses: orhun/git-cliff-action@v1
id: git-cliff id: git-cliff
with: with:
config: cliff.toml config: cliff.toml
args: --verbose args: --verbose
env: env:
OUTPUT: CHANGELOG.md OUTPUT: CHANGELOG.md
- name: Print the changelog - name: Print the changelog
run: cat "${{ steps.git-cliff.outputs.changelog }}" run: cat "${{ steps.git-cliff.outputs.changelog }}"
``` ```
#### Advanced #### Advanced
@@ -49,37 +54,59 @@ The following example generates a changelog for the latest pushed tag and sets i
It uses [svenstaro/upload-release-action](https://github.com/svenstaro/upload-release-action) for uploading the release assets. It uses [svenstaro/upload-release-action](https://github.com/svenstaro/upload-release-action) for uploading the release assets.
```yml ```yml
- name: Checkout jobs:
uses: actions/checkout@v2 changelog:
with: name: Generate changelog
fetch-depth: 0 runs-on: ubuntu-latest
outputs:
release_body: ${{ steps.release.outputs.RELEASE_BODY }}
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Generate a changelog - name: Generate a changelog
uses: orhun/git-cliff-action@v1 uses: orhun/git-cliff-action@v1
id: git-cliff id: git-cliff
with: with:
config: cliff.toml config: cliff.toml
args: -vv --latest --strip header args: -vv --latest --strip header
env: env:
OUTPUT: CHANGES.md OUTPUT: CHANGES.md
- name: Set the release body - name: Set the release body
id: release id: release
shell: bash shell: bash
run: | run: |
r=$(cat ${{ steps.git-cliff.outputs.changelog }}) r=$(cat ${{ steps.git-cliff.outputs.changelog }})
r="${r//'%'/'%25'}" # Multiline escape sequences for % r="${r//'%'/'%25'}" # Multiline escape sequences for %
r="${r//$'\n'/'%0A'}" # Multiline escape sequences for '\n' r="${r//$'\n'/'%0A'}" # Multiline escape sequences for '\n'
r="${r//$'\r'/'%0D'}" # Multiline escape sequences for '\r' r="${r//$'\r'/'%0D'}" # Multiline escape sequences for '\r'
echo "::set-output name=RELEASE_BODY::$r" echo "::set-output name=RELEASE_BODY::$r"
- name: Upload the binary releases # use release body in the same job
uses: svenstaro/upload-release-action@v2 - name: Upload the binary releases
with: uses: svenstaro/upload-release-action@v2
file: binary_release.zip with:
repo_token: ${{ secrets.GITHUB_TOKEN }} file: binary_release.zip
tag: ${{ github.ref }} repo_token: ${{ secrets.GITHUB_TOKEN }}
body: ${{ steps.release.outputs.RELEASE_BODY }} tag: ${{ github.ref }}
body: ${{ steps.release.outputs.RELEASE_BODY }}
# use release body in another job
upload:
name: Upload the release
needs: changelog
runs-on: ubuntu-latest
steps:
- name: Upload the binary releases
uses: svenstaro/upload-release-action@v2
with:
file: binary_release.zip
repo_token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ github.ref }}
body: ${{ needs.changelog.outputs.release_body }}
``` ```
## Credits ## Credits