serokell/xrefcheck
1
1
Fork 0
mirror of https://github.com/serokell/xrefcheck.git synced 2024-08-17 01:20:44 +03:00
Code Issues Projects Releases Wiki Activity
Check cross-references in repository documents
53 Commits 33 Branches 10 Tags 1.3 MiB
Haskell 80.4%
Shell 11.1%
Ruby 4.9%
Nix 2.3%
Makefile 1.3%
e6ceeb9284
Go to file
martoon e6ceeb9284
Add issue templates 
Problem: by default, when creating an issue, user has to fill everything
from scratch and this is not good.

Solution: add issue templates for `task` and `bug`, refer people to
page for openning new issue in `CONTRIBUTING.md`.
2019-12-06 18:38:12 +03:00
.github Add issue templates 2019-12-06 18:38:12 +03:00
exec Improve work with config UX 2019-12-05 14:15:20 +03:00
nix Use niv for cache 2019-12-05 00:00:39 +03:00
src/Crv Fail if haddock is not generated 2019-12-05 18:03:30 +03:00
src-files Make providing config optional 2019-12-03 23:19:37 +03:00
tests Make providing config optional 2019-12-03 23:19:37 +03:00
.gitignore Also build tests 2019-12-05 19:01:57 +03:00
default.nix Also build tests 2019-12-05 19:01:57 +03:00
LICENSE Add README and other required meta files 2019-03-14 20:29:36 +03:00
package.yaml Also build tests 2019-12-05 19:01:57 +03:00
README.md Write some notes about CI in README 2019-12-05 00:00:41 +03:00
Setup.hs [INT-31] Implement cross-references verifier 2018-10-11 02:51:28 +03:00
stack.yaml Use newer resolver 2019-12-05 00:00:34 +03:00

README.md

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:

  1. nix/sources.json lists all such dependencies that we obtain using git. It specifies concrete git revisions and SHA256 checksums.
  2. 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.