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

Adding GitHub action for link check of user guide #1441

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

deining
Copy link
Collaborator

@deining deining commented Feb 24, 2023

With #1172, link checking in the user guide was introduced, thanks for that @chalin. A comment given in this PR states:

This isn't my ideal setup because I'd like to avoid the makefile entirely

This PR follows up on this comment and proposes an approach that allows to eleminate userguide/Makefile introduced with #1172.
This is done by adding GitHub action that makes use of the htmltest link checker to check the links of the user guide.
In its current form, this link check action will be performed on each push to the main branch of the docsy repo (this can be adapted, of course). To see the results of the last workflow run(s), select the htmltest workflow in the Actions section of the GitHub web UI. On the same page, you can also disable the workflow if needed. To do so, press the button right beneath the search field that allows you to filter workflow runs.

This PR added two URLs to the IgnoredURLs setting in the config file of the link checker. With this adapation, the link checker currently reports back green status for the link check:

grafik

I hope you like this PR. If opens up several possibilities to streamline the workflow e.g. for pull requests.

Note:: In order to allow the Github action workflow to cache npm dependencies, packages.json.lock was added to the repo.

@deining deining added user guide Improvements to user guide CI/infra CI & infrastructure labels Feb 24, 2023
@deining deining requested a review from chalin February 24, 2023 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure user guide Improvements to user guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant