Skip to content

Commit

Permalink
docs: update documentation for actions/checkout@v2
Browse files Browse the repository at this point in the history
actions/checkout@v2 behaves differently than the first version.
Therefore the README needs an update.
  • Loading branch information
fallion committed Mar 4, 2021
1 parent ee9fcaf commit d845fe7
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,36 @@ Slack integration posts release notes into Slack using the `Incoming webhook` in

#### Using Github actions

##### actions/checkout@v2

actions/checkout@v2 behaves differently from the first version. It pulls in just the latest commit and does not pull any other git objects. Release Notary needs these objects in order to work.

It should be run only on tags.

Example workflow file:

```yaml
name: Release
on:
push:
tags:
- v*
jobs:
release-notes:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Release Notary Action
uses: docker://aevea/release-notary:0.9.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
##### actions/checkout@v1
Should be run only on tags, example is [HERE](https://github.com/aevea/commitsar/blob/master/.github/workflows/release.yml):
```yml
Expand Down

0 comments on commit d845fe7

Please sign in to comment.