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

Add linkcheck to CI #141

Merged
merged 11 commits into from
Nov 5, 2024
Merged

Add linkcheck to CI #141

merged 11 commits into from
Nov 5, 2024

Conversation

anissa111
Copy link
Member

@anissa111 anissa111 commented Nov 4, 2024

This PR:

  • adds a linkcheck to CI
    • adds linkcheck.yml as a separate action workflow file so that our entire CI won't show as failing if just linkcheck is having problems and potential linkcheck problems won't necessarily block PRs.
    • runs on main at 00:30 UTC, on PRs, and on workflow call
    • reuses the environment generated by nightly checks (hence running at 00:30 UTC)
  • and addresses some stuff that made it fail
    • adds :ref: roles to internal links in cards in applications/applications.rst and index.rst
    • alters references.bib to remove redundant urls and correct a typo in a doi
    • adds linkcheck_anchors = False to conf.py to allow linking to specific line numbers on github (invalid anchors will still go to the intended page, just not the intended location)
    • adds linkcheck_ignore = [r'https://doi.org/10.1080/104732299303296'] to conf.py. I tried to do some stuff with the user agent, but ultimately, this page is really interested in keeping track of the number of people who access it and I don't want to mess with their stats.

Addresses GA-1499

@anissa111 anissa111 marked this pull request as draft November 4, 2024 20:20
@anissa111 anissa111 changed the title linkcheck Add linkcheck to CI Nov 4, 2024
Copy link

github-actions bot commented Nov 4, 2024

Meowdy! See your PR preview:
🔍 Git commit SHA: 6668352
✅ Deployment Preview URL: https://NCAR.github.io/geocat-applications/_preview/141

@anissa111
Copy link
Member Author

@anissa111 anissa111 marked this pull request as ready for review November 4, 2024 21:20
@anissa111 anissa111 requested review from kafitzgerald, jukent and cyschneck and removed request for kafitzgerald November 4, 2024 21:20
Copy link
Contributor

@cyschneck cyschneck left a comment

Choose a reason for hiding this comment

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

Looks good, might be worth updating the Contributor guide to mention some of the link details like using ref

Copy link
Collaborator

@kafitzgerald kafitzgerald left a comment

Choose a reason for hiding this comment

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

Looks great!

Unreasonably excited to have this 😆

@anissa111 anissa111 merged commit c491130 into NCAR:main Nov 5, 2024
3 checks passed
@anissa111 anissa111 deleted the linkcheck branch November 5, 2024 00:06
github-actions bot pushed a commit that referenced this pull request Nov 5, 2024
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.

3 participants