Skip to content

Commit 174d577

Browse files
arnavk23CopilotIanButterworth
authored
Docs : clarify permissions problem causing TagBot failures. (#434)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ian Butterworth <i.r.butterworth@gmail.com>
1 parent 75879e4 commit 174d577

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ Check that workflows have the correct permissions on your repo.
1717

1818
![Workflow permissions](workflow_permissions.png)
1919

20+
> [!IMPORTANT]
21+
> **Do not add explicit `permissions:` to your TagBot workflow!**
22+
> Adding explicit permissions (even with `contents: write`) will prevent TagBot from creating releases.
23+
> The default GitHub Actions token permissions are sufficient and necessary for TagBot to work correctly.
24+
2025
> [!NOTE]
2126
> No further action should be required on your part, but if TagBot fails and you see `403: Resource not accessible by integration`
2227
errors, try adding (or refreshing) an SSH key with the correct permissions. See the [SSH Deploy Keys](#ssh-deploy-keys) section below.
@@ -502,8 +507,9 @@ $ poetry run python -m tagbot.local --help
502507

503508
### I am seeing some kind of permissions error
504509

505-
* Check that your configuration matches the one shown in [Setup](#Setup), especially the `permissions` block
506-
* Try using an [ssh deploy key](#SSH-Deploy-Keys) even if you aren't using Documenter or otherwise need to trigger workflows from TagBot-generated tags
510+
* **First, check if you have a `permissions:` block in your TagBot workflow file.** If you do, **remove it entirely**. Explicit permissions (even with `contents: write`) prevent TagBot from creating releases due to GitHub's permission model. The default GitHub Actions token permissions are what TagBot needs.
511+
* Check that your repository settings allow GitHub Actions to create releases (see [Setup](#setup))
512+
* Try using an [ssh deploy key](#ssh-deploy-keys) even if you aren't using Documenter or otherwise need to trigger workflows from TagBot-generated tags
507513

508514
### I am missing old tags
509515

0 commit comments

Comments
 (0)