Skip to content

Commit 9501314

Browse files
author
Daniel McKenzie
committed
Update README.md
1 parent a960598 commit 9501314

File tree

1 file changed

+0
-37
lines changed

1 file changed

+0
-37
lines changed

README.md

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -24,53 +24,16 @@ Inside your `.github/workflows/workflow.yml` file:
2424
steps:
2525
- uses: actions/checkout@v1
2626
- uses: RiskLedger/generate-changelog@v2
27-
with:
28-
from: ${ value }} # The old commit sha or tag you'd like to compare with
29-
to: ${GITHUB_SHA} # The commit SHA that triggered the workflow run
3027
env:
3128
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
3229
```
3330
34-
> **Note**: If you need to get the previous commit, (e.g. comparing the diff between your current branch dev & master), this can be achieved with the following:
35-
>
36-
```yaml
37-
jobs:
38-
check_master:
39-
runs-on: ubuntu-latest
40-
outputs:
41-
last_commit: ${{ steps.get-master-sha.outputs.sha }}
42-
steps:
43-
- name: Get latest commit from master
44-
id: get-master-sha
45-
run: |
46-
echo ::set-output name=sha::$( curl -u "u:${{ secrets.GITHUB_TOKEN }}" https://api.github.com/repos/USERNAME/REPO/git/ref/heads/master | jq .object.sha | tr -d '"' )
47-
48-
create_notes:
49-
needs: check_master
50-
runs-on: 'ubuntu-latest'
51-
outputs:
52-
changelog: ${{ steps.changelog.outputs.changelog }}
53-
steps:
54-
- uses: actions/checkout@v1
55-
56-
- name: Generate the changelog
57-
id: changelog
58-
uses: riskledger/generate-changelog@exec
59-
with:
60-
from: ${{ needs.check_master.outputs.last_commit }}
61-
to: ${{ github.sha }}
62-
env:
63-
GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
64-
```
65-
6631
## Arguments
6732
6833
This action currently supports two inputs from the user: `from` and `to`. These inputs, along with their descriptions and usage contexts, are listed in the table below:
6934

7035
| Input | Description | Usage |
7136
| :-----: | :---------------------------------------------------------------------------------------------------------: | :--------: |
72-
| `from` | This commit or tag you would like to compare against uploads | _Required_ |
73-
| `to` | Path to the coverage report(s) | _Required_ |
7437
| `token` | Your Github access token, which will already be avaliable within your workflow without any additional setup | _Required_ |
7538

7639
## License

0 commit comments

Comments
 (0)