Skip to content

Commit

Permalink
docs-lint: don't validate Fx compare links (#1172)
Browse files Browse the repository at this point in the history
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:
```
$ make docs-lint
Checking documentation
...
error:          changelog.md:19: "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
```
  • Loading branch information
JacobOaks authored Mar 8, 2024
1 parent 6ddbd03 commit bf48ba3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/.mdox-validate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ validators:
# use the GitHub API.
- regex: '(^http[s]?:\/\/)(www\.)?(github\.com\/)uber-go\/fx(\/pull\/|\/issues\/)'
type: 'githubPullsIssues'
- regex: '^http[s]://github.com/uber-go/fx/compare/[^/]*$'
type: 'ignore'

0 comments on commit bf48ba3

Please sign in to comment.