Problem: CI uses some temporary workarounds, one may wonder whether they are necessary and not get an answer. Solution: write about it in README.
1.8 KiB
Crossref-verifier
Tool for verifying local and external references in repository documentation.
For now, support for markdown files only is provided.
Build instructions ↑
Run stack install
to build everything and install executable.
CI and nix ↑
CI uses nix-build
to build the project.
It is based on the haskell.nix
project.
You can do that too if you want.
There is a bug which causes us to put some redundancy into Nix files:
nix/sources.json
lists all such dependencies that we obtain usinggit
. It specifies concrete git revisions and SHA256 checksums.default.nix
lists all such dependencies as well, but without revisions.
As a consequence, you may have to update these files when you update stack.yaml
.
You can use niv update
to update nix/sources.json
.
Usage ↑
To find all broken links in repository run
crossref-verify --root <repository>
For description of other options
crossref-verify --help
Issue tracker ↑
We use YouTrack as our issue tracker. You can login using your GitHub account to leave a comment or create a new issue.
For Contributors ↑
Please see CONTRIBUTING.md for more information.
About Serokell ↑
Crossref-verifier is maintained by Serokell.
We love open source software. See which services we provide and drop us a line if you are interested.