docs(readme): update examples

This commit is contained in:
orhun
2021-07-02 01:19:16 +03:00
parent 30c8d01aac
commit f33ebb9c7f

View File

@@ -24,6 +24,11 @@ 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.
```yml
jobs:
changelog:
name: Generate changelog
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
@@ -49,6 +54,13 @@ 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.
```yml
jobs:
changelog:
name: Generate changelog
runs-on: ubuntu-latest
outputs:
release_body: ${{ steps.release.outputs.RELEASE_BODY }}
steps:
- name: Checkout
uses: actions/checkout@v2
with:
@@ -73,6 +85,7 @@ It uses [svenstaro/upload-release-action](https://github.com/svenstaro/upload-re
r="${r//$'\r'/'%0D'}" # Multiline escape sequences for '\r'
echo "::set-output name=RELEASE_BODY::$r"
# use release body in the same job
- name: Upload the binary releases
uses: svenstaro/upload-release-action@v2
with:
@@ -80,6 +93,20 @@ It uses [svenstaro/upload-release-action](https://github.com/svenstaro/upload-re
repo_token: ${{ secrets.GITHUB_TOKEN }}
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