docs: fix status badges in readme #1143
Merged
Conversation
This file contains 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
|
|
Preview https://github.com/MikeMcC399/github-action/blob/fix/status-badges/README.md - in general https://github.com/MikeMcC399/github-action/blob/fix/status-badges/README.md#pnpm-workspaces for the specific pnpm workspaces issue |
|
🎉 This PR is included in version 6.7.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Issue
The badge for the newly-added workflow .github/workflows/example-start-and-pnpm-workspaces.yml shows "no status", instead of the expected "passed" status in the README > pnpm workspaces section.
Changes
Most status badges in the README do not conform to the documentation Adding a workflow status badge which specifies the format
OWNER=cypress-ioREPOSITORY=github-actionWORKFLOW-FILE= e.g.example-start-and-pnpm-workspaces.yml(including the.ymlextension)In all badges, where necessary,
/github-action/workflows/to/github-action/actions/workflows/.ymlextension where missing?branch=mastersince this is unnecessary. It is the default setting.Verification
Scroll through the README file and check that all status badges are showing a status of "passed".