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

docs(readme): reword the checkout note

Browse Source
This commit is contained in:
Orhun Parmaksız
2024-06-20 22:58:05 +03:00
parent 16d19c9a34
commit 39636424cd
1 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -20,18 +20,16 @@ This action generates a changelog based on your Git history using [git-cliff](ht
- `OUTPUT`: Output file. (Default: `"git-cliff/CHANGELOG.md"`) - `OUTPUT`: Output file. (Default: `"git-cliff/CHANGELOG.md"`)
> [!IMPORTANT] > [!IMPORTANT]
> It is important to checkout the repositories as: > Check out the entire history via `fetch-depth: 0` before running this action.
> >
> ```yaml > ```yaml
> - name: Checkout > - name: Checkout
> uses: actions/checkout@v4 > uses: actions/checkout@v4
> with: > with:
> fetch-depth: 0 > fetch-depth: 0
> ``` > ```
> >
> `fetch-depth: 0` the is key input here to checkout action. > Otherwise, you might end up getting empty changelogs or `git ref` errors depending on arguments passed to `git-cliff`.
>
> Otherwise, you might end-up getting empty changelogs or `git ref` errors depending on arguments passed to `git-cliff`.
### Examples ### Examples