Skip to content
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

chore(ci): add markdown-link-check action #939

Merged
merged 2 commits into from
Apr 22, 2024
Merged

chore(ci): add markdown-link-check action #939

merged 2 commits into from
Apr 22, 2024

Conversation

jeertmans
Copy link
Contributor

Add a check to prevent dead links in the future (e.g., #937).

Output of markdown-link-check CONTRIBUTING.md README.md > output.txt 2>&1:


FILE: CONTRIBUTING.md
  [✓] https://cla.developers.google.com/
  [✓] https://help.github.com/articles/about-pull-requests/
  [✓] https://opensource.google.com/conduct/

  3 links checked.

FILE: README.md
  [✓] http://optax.readthedocs.io
  [✓] https://optax.readthedocs.io/
  [✓] https://optax.readthedocs.io/en/latest/api/optimizers.html
  [✓] https://optax.readthedocs.io/en/latest/api/losses.html
  [✖] https://github.com/google-deepmind/optax/blob/main/docs/optax-101.ipynb
  [✓] https://arxiv.org/pdf/2306.07179
  [✓] https://proceedings.mlr.press/v139/schmidt21a
  [✓] https://arxiv.org/abs/2206.13424
  [✓] https://github.com/google-research/tuning_playbook
  [✓] https://github.com/google-deepmind/optax/actions/workflows/tests.yml/badge.svg?branch=main
  [✓] https://readthedocs.org/projects/optax/badge/?version=latest
  [✓] https://img.shields.io/pypi/v/optax

  12 links checked.

  ERROR: 1 dead links found!
  [✖] https://github.com/google-deepmind/optax/blob/main/docs/optax-101.ipynb → Status: 404

Add a check to prevent dead links in the future (e.g., #937).
Copy link
Collaborator

@vroulet vroulet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@copybara-service copybara-service bot merged commit 606fac2 into google-deepmind:main Apr 22, 2024
6 of 7 checks passed
@jeertmans jeertmans deleted the markdown-link-check branch April 22, 2024 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants