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: add link checking in CI #1766

Merged
merged 1 commit into from
May 4, 2022
Merged

Conversation

huitseeker
Copy link
Contributor

@huitseeker huitseeker commented May 4, 2022

This adds a link-checking action run on a weekly basis (Mondays) using lychee:

The check can also be triggered manually using the Github CLI or the 'Actions' tab interface for contributors of the repo.

This does not act on PRs but rather publishes / updates an issue on the repo with the link check report.

Demo run:
https://github.com/huitseeker/sui/runs/6282514162?check_suite_focus=true

Demo resulting issue:
huitseeker#4

We should also include a configuration file ./lychee.toml with possible excludes and other details, see documentation. This is a first stab, though.

This adds a link-checking action run on a weekly basis using lychee:

The check can also be triggered manually using the Github CLI or the 'Actions' tab interface for contributors of the repo.

This does not act on PRs but rather publishes / updates an issue on the repo with the link check report.
@Clay-Mysten
Copy link
Contributor

Adding here since we never created an issue for this change:

Me: May I ask to be made the default assignee on these reports? FWIW, I
Francois: You can do that yourself by a PR against the GH action.
here's the doc:
https://github.com/peter-evans/create-issue-from-file#action-inputs
here's the line that needs changing:
with:
title: Link checker report
content-filepath: ${{ env.LYCHEE_OUT }}
issue-number: ${{ steps.last_issue.outputs.issue_number }}
labels: |
report
automated issue

Done:
#1961
MystenLabs/narwhal#242

@huitseeker huitseeker deleted the links_checker branch January 21, 2023 13:36
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