Improve Labeler Action Documentation and Error Handling for Permissions #897
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This pull request improves the GitHub Labeler Action by enhancing documentation clarity around required permissions and implementing better error handling to guide users when permission issues occur. The changes help users understand the distinction between permissions needed for adding existing labels versus creating new labels.
- Enhanced error handling to detect unauthorized errors and provide specific guidance for missing permissions
- Expanded documentation to clarify permission requirements for different use cases
- Added example workflow configuration and alternative solutions for avoiding
issues: writepermission
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/labeler.ts | Added specific error detection for 403 unauthorized errors with detailed guidance on required permissions |
| README.md | Expanded permissions documentation with clearer explanations, example configuration, and manual label creation alternative |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…o granting issues write permission
… access instead of logging
5 tasks
mahabaleshwars
approved these changes
Sep 15, 2025
aparnajyothi-y
approved these changes
Sep 18, 2025
HarithaVattikuti
approved these changes
Sep 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This pull request updates the GitHub Labeler Action documentation and error handling to clarify required permissions and provide better guidance for resolving issues. The changes include detailed permission requirements, alternative solutions for label creation, and improved error messaging in the code.
Documentation Updates:
README.md: Expanded the explanation of required permissions for adding and creating labels (pull-requests: writeandissues: write), added an example workflow configuration, and provided an alternative for manual label creation to avoid grantingissues: writepermission.Error Handling Improvements:
src/labeler.ts: Enhanced error handling to detect unauthorized errors, provide specific guidance for missing permissions, and improve warning messages with clearer descriptions of required permissions and alternatives.Related issue:
#870
Check list: