python-template icon indicating copy to clipboard operation
python-template copied to clipboard

Make link checker less verbose

Open sverhoeven opened this issue 3 years ago • 0 comments

The link checker GHA workflows output is very verbose making it hard to see which links are actually broken. Can the verboseness be reduced with use-quiet-mode: 'yes' in workflow step.

Adding this flag gives

act -W .github/workflows/markdown-link-check.yml push
...
| FILE: ./{{cookiecutter.project_name}}/.github/next_steps/05_linting.md
| 
| 0 links checked.
| 
| FILE: ./{{cookiecutter.project_name}}/.github/next_steps/04_citation.md
| [✖] https://yamllint.com
| 
| 6 links checked.
| 
| ERROR: 1 dead links found!
| [✖] https://yamllint.com → Status: 0
| 
| FILE: ./{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md
| 
| 0 links checked.
| 
...

Which I think is much easier to find dead links then with

| FILE: ./{{cookiecutter.project_name}}/.github/next_steps/05_linting.md
| No hyperlinks found!
| 
| 0 links checked.
| 
| FILE: ./{{cookiecutter.project_name}}/.github/next_steps/04_citation.md
| [/] {{cookiecutter.repository}}/actions/workflows/cffconvert.yml
| [✓] https://github.com/citation-file-format/citation-file-format
| [✓] https://orcid.org/
| [✓] https://help.zenodo.org/
| [✖] https://yamllint.com
| [✓] https://jsonlint.com/
| 
| 6 links checked.
| 
| ERROR: 1 dead links found!
| [✖] https://yamllint.com → Status: 0
| 
| FILE: ./{{cookiecutter.project_name}}/.github/next_steps/02_zenodo_integration.md
| No hyperlinks found!
| 
| 0 links checked.

I don't care if links are working, so I would rather not see them.

sverhoeven avatar Apr 30 '21 09:04 sverhoeven