fix: update badges, use immutable releases, and update an error message#53
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances project documentation, improves error messaging, and updates release workflows for better clarity and maintainability.
- Updated README badges and version references to reflect v3 and highlight immutable releases
- Improved error message for team access failures to include organization context
- Added JSDoc return type annotations for better code documentation
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Added new badges for releases and marketplace, updated usage example to reference v3 |
| src/index.js | Enhanced error message with organization context, added JSDoc @returns annotations |
| src/index.test.js | Updated test assertion to match improved error message |
| .github/workflows/publish.yml | Configured releases to be created as drafts for better review process |
| badges/coverage.svg | Updated coverage badge reflecting slight increase to 98.21% |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documentation updates:
README.mdfor GitHub releases, immutable releases, and marketplace presence, providing clearer status and discoverability of the project.README.mdto referencejoshjohanning/approveops@v3instead of@v2, ensuring users adopt the latest version.Workflow configuration:
.github/workflows/publish.ymlto create releases as drafts by default, improving release management and review processes.Code and error handling improvements:
src/index.jsfor team access failures to include organization context and permission details, and updated corresponding test to match the new message. [1] [2]@returnsannotations topostCommentandrunfunctions insrc/index.js, clarifying their return types for better developer understanding. [1] [2]up