Docs : clarify permissions problem causing TagBot failures. #434
Conversation
Add _check_rate_limit() method to query GitHub API rate limit status and log remaining/limit/reset information when 403 errors are encountered. This helps distinguish between rate limiting and permission issues.
…#315) TagBot now normalizes UUIDs to lowercase when looking them up in the registry, matching the registry's behavior. This fixes the issue where packages with uppercase UUIDs were being ignored by TagBot. - Normalize UUID in _registry_path property - Normalize UUID in _registry_pr method - Add test for uppercase UUID handling
…ks TagBot - Add IMPORTANT callout in Setup section warning against adding explicit permissions: block to TagBot workflow - Update troubleshooting section to explicitly tell users to REMOVE any permissions: block if present - Explain that default GitHub Actions token permissions are what TagBot needs and explicit permissions (even with contents: write) prevent TagBot from creating releases This addresses issues JuliaRegistries#267 and JuliaRegistries#388 where users added explicit permissions blocks (often from outdated examples) which caused 403 errors when TagBot tried to create releases. The fix in PR JuliaRegistries#392 removed permissions from the example workflow, but documentation needed to be clearer about why.
There was a problem hiding this comment.
Pull request overview
This PR improves documentation to prevent TagBot workflow failures caused by users adding explicit permissions: blocks to their workflows. The changes clarify that explicit permissions (even with contents: write) override GitHub's default token permissions in a way that prevents TagBot from creating releases, which was causing 403 errors.
- Added a prominent IMPORTANT callout in the Setup section warning against using explicit permissions
- Updated troubleshooting guidance to prioritize removing explicit permissions blocks as the first debugging step
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@IanButterworth please review this pr. Thanks! |
|
The commits on this branch are a bit messed up. Can you reset your master branch to upstream/master and rebase this on that. |
2 participants
Users were adding explicit permissions: blocks to their TagBot workflows (often copying from outdated examples)
This caused 403 errors when TagBot tried to create releases, even with contents: write permission
The root cause was that GitHub's permission model changed, and explicit permissions override the default token permissions in a way that breaks TagBot