Skip to content

Commit 6739571

Browse files
committed
Add Note about persist-credentials to README
1 parent b811de3 commit 6739571

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ jobs:
4242
- uses: actions/checkout@v5
4343
with:
4444
ref: ${{ github.head_ref }}
45+
# Value already defaults to true, but `persist-credentials` is required to push new commits to the repository.
46+
persist-credentials: true
4547

4648
# Other steps that change files in the repository go here
4749
#
@@ -444,7 +446,9 @@ Make sure to [checkout the correct branch](#checkout-the-correct-branch).
444446
If your Workflow can't push the commit to the repository because of authentication issues,
445447
please update your Workflow configuration and usage of [`actions/checkout`](https://github.com/actions/checkout#usage).
446448
447-
Updating the `token` value with a Personal Access Token should fix your issues.
449+
Please note that `persist-credentials` in `actions/checkout` must be set to `true` to push new commits to the repository.
450+
451+
If you still can't push the commit, and you're using branch protection rules or similar features, updating the `token` value with a Personal Access Token should fix your issues.
448452
449453
### git-auto-commit fails to push commit that creates or updates files in `.github/workflows/`
450454

0 commit comments

Comments
 (0)