-
Notifications
You must be signed in to change notification settings - Fork 148
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[8.x](backport #5443) mage: check that links are live in the OTel README #5667
Conversation
* mage: add check that links are live in the OTel README This PR adds a utility based on the `link-patrol` command to check if links in a given file are live. Added a check in the `check` and `otel:readme` targets to validate all links in the Otel Readme are valid. * remove unused directive for forbidigo * update doc for LinkCheck * update NOTICE.txt * Update license header with Elastic License 2.0 --------- Co-authored-by: Shaunak Kashyap <[email protected]> (cherry picked from commit 835cd9c) # Conflicts: # go.mod # go.sum
Cherry-pick of 835cd9c has failed:
To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are conflicts in this branch, leaving on hold until I fix them.
This pull request is now in conflicts. Could you fix it? 🙏
|
/test |
This pull request is now in conflicts. Could you fix it? 🙏
|
This pull request has not been merged yet. Could you please review and merge it @mauri870? 🙏 |
Quality Gate passedIssues Measures |
This PR adds a utility based on the
link-patrol
command to check if links in a given file are live. This utility should be reusable so we can use it to validate other files in the repository.Also added a check in the
check
andotel:readme
mage targets to validate all links in the Otel Readme are valid.What does this PR do?
Why is it important?
./changelog/fragments
using the changelog toolHow to test this PR locally
You can either run
mage check
ormage otel:readme
to trigger the link check.To test it indeed fails if a link is invalid you can introduce a typo and it should fail in subsequent runs.
sed -i 's/featuregate/fff/' internal/pkg/otel/templates/README.md.tmpl
Related issues
This is an automatic backport of pull request mage: check that links are live in the OTel README #5443 done by Mergify.