Remove release dependency on markdown link check (Rev2)#765
Merged
Conversation
Collaborator
Author
|
This PR is now ready for review and merge.
The PR does not trigger a release. The final check will occur the next time a release is triggered, however since the change to .github/workflows/main.yml is very minimal (removal of the |
This was referenced Feb 1, 2023
jaffrepaul
approved these changes
Feb 3, 2023
jaffrepaul
left a comment
Contributor
There was a problem hiding this comment.
Great stuff, thanks @MikeMcC399!
|
🎉 This PR is included in version 5.0.8 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
2 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.
This PR resolves issue #717 "Bad external links may block release". It is a rework of PR #762.
In .github/workflows/main.yml
npm run check:markdownis removed from thebuild-and-testjob and placed inside a new independent workflow .github/workflows/check-markdown.yml.This means that a release can optionally be carried out independently of a markdown link error. This may be necessary and desired if a link failure is caused by a temporary issue on an external website. If on the other hand there is a hard failure in a markdown hyperlink this should preferably be corrected before a PR is merged for release.
The change in this PR gives the decision-making to the person merging the PR. An automatic block of releasing caused by a bad external website no longer takes place.
Verification
Markdown error case
npm run check:markdownlocally and verify the test failsIn a copy of the cypress-io/github-action/ repo:
Markdown non-error case
npm run check:markdownlocally and verify the test succeeds