feat: adds zk linkcheck to ci to prevent dead links
#870
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jan 13, 2024
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 15, 2024
…heck` ci usage (#868) Related PRs: - #869 - #870 ## What ❔ - Adds `zk linkcheck` to zk tool - Adds required dependencies to make use of `zk linkcheck` in zk env - Adds `zk linkcheck` docs - Updates `spellcheck` dir to be general `checks-config` dir to include spellcheck and link configuration files - Fixes issue with `zk spellcheck` exit code <!-- What are the changes this PR brings about? --> <!-- Example: This PR adds a PR template to the repo. --> <!-- (For bigger PRs adding more context is appreciated) --> ## Why ❔ - `zk linkcheck` will ensure no dead links exist in repo and prevent unnecessary PRs - Required to install dependencies, similar to `zk spellcheck` - Relevant docs to outline `zk linkcheck` usage <!-- Why are these changes done? What goal do they contribute to? What are the principles behind them? --> <!-- Example: PR templates ensure PR reviewers, observers, and future iterators are in context about the evolution of repos. --> ## Checklist <!-- Check your PR fulfills the following items. --> <!-- For draft PRs check the boxes as you complete them. --> - [x] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [ ] Tests for the changes have been added / updated. - [x] Documentation comments have been added / updated. - [x] Code has been formatted via `zk fmt` and `zk lint`. - [x] Spellcheck has been run via `zk spellcheck`.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 18, 2024
Related PRs: - #868 - #870 ## What ❔ - Addresses broken links in the repo <!-- What are the changes this PR brings about? --> <!-- Example: This PR adds a PR template to the repo. --> <!-- (For bigger PRs adding more context is appreciated) --> ## Why ❔ - Should not have dead links in the repo - Addressing issues with links prior to `zk linkcheck` usage in ci <!-- Why are these changes done? What goal do they contribute to? What are the principles behind them? --> <!-- Example: PR templates ensure PR reviewers, observers, and future iterators are in context about the evolution of repos. --> ## Checklist <!-- Check your PR fulfills the following items. --> <!-- For draft PRs check the boxes as you complete them. --> - [x] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [ ] Tests for the changes have been added / updated. - [x] Documentation comments have been added / updated. - [x] Code has been formatted via `zk fmt` and `zk lint`. - [x] Spellcheck has been run via `zk spellcheck`.
dutterbutter
force-pushed
the
db/add-linkchecker-to-ci
branch
from
5ae013e
to
2067a38
Compare
dutterbutter
force-pushed
the
db/add-linkchecker-to-ci
branch
from
54cd3f0
to
85ca947
Compare
dutterbutter
requested review from
yorik,
alexandrst88,
artmakh,
hatemosphere,
onyxet and
otani88
otani88
reviewed
Jan 24, 2024
…ync-era into db/add-linkchecker-to-ci
otani88
approved these changes
Jan 26, 2024
joonazan
pushed a commit
that referenced
this pull request
Jan 30, 2024
## What ❔ - Adds `zk linkcheck` to CI - Adds `zk linkcheck` to Pull request template <!-- What are the changes this PR brings about? --> <!-- Example: This PR adds a PR template to the repo. --> <!-- (For bigger PRs adding more context is appreciated) --> ## Why ❔ - Prevents dead links from being introduced to repo <!-- Why are these changes done? What goal do they contribute to? What are the principles behind them? --> <!-- Example: PR templates ensure PR reviewers, observers, and future iterators are in context about the evolution of repos. --> ## Checklist <!-- Check your PR fulfills the following items. --> <!-- For draft PRs check the boxes as you complete them. --> - [x] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [ ] Tests for the changes have been added / updated. - [x] Documentation comments have been added / updated. - [x] Code has been formatted via `zk fmt` and `zk lint`. - [x] Spellcheck has been run via `zk spellcheck`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What ❔
zk linkcheckto CIzk linkcheckto Pull request templateWhy ❔
Checklist
zk fmtandzk lint.zk spellcheck.