docs-lint: don't validate Fx compare links #1172
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
The lint CI step for uber-go#1171 is failing because it adds a comparison link in the changelog that does not yet exist (the 1.20.2 tag has not been created yet). This PR ignores these types of links when validating links during docs linting in CI. Tested this by adding the link from uber-go#1171 into the changelog. Before this change: ``` $ make docs-lint Checking documentation ... error: changelog.md:19: "uber-go/fx@v1.20.0...v1.20.2" not accessible; status code 404: Not Found make[1]: *** [check] Error 1 make: *** [docs-lint] Error 2 ``` After this change: ``` $ make docs-lint Checking documentation ```
abhinav
approved these changes
Mar 8, 2024
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.
The lint CI step for #1171 is failing because it adds a comparison link in the changelog that does not yet exist (the 1.20.2 tag has not been created yet).
This PR ignores these types of links when validating links during docs linting in CI.
Tested this by adding the link from #1171 into the changelog.
Before this change:
After this change: