Stefan Verhoeven

Make link checker quicker

1

It takes about a 1 minute to perform the check on all links in this repository and on generated repo. The [action](https://github.com/gaurav-nelson/github-action-markdown-link-check) has an option to only check changed files...

Warning when Sonar analysis is performed on external PR

2

A external contributor will fork the repo and create a pull request according to [contributing docs](https://github.com/NLeSC/python-template/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/CONTRIBUTING.md#you-want-to-make-some-kind-of-change-to-the-code-base). The Sonar cloud analysis workflow will fail, because [secrets are not available](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull-request-events-for-forked-repositories) on external...

Sonarcloud instructions incomplete

1

[01_sonarcloud_integration.md](https://github.com/NLeSC/python-template/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/.github/next_steps/01_sonarcloud_integration.md) is incomplete. * Token was asked earlier then expected * Did not know which language to pick * Configuring new code definition needs commit+push first * To verify SonarCloud...

authentication confusion when doing git push in next_steps.md

1

Asked password is not your GitHub password, but must be a personal access token. This is confusing to people who have not used GitHub before. Add https://docs.github.com/en/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token link to next_steps.md...

For library users it is beneficial if [typings](https://docs.python.org/3/library/typing.html) in the library are available. It will make writing code in an IDE much richer and less error prone. Having typing from...

Use library for git pre commit hook

3

Currently we can use a git hook on pre commit to check style and import order with https://github.com/NLeSC/python-template/blob/c19f866479cd94abcb0151e6f9bc7c55e898b8bc/%7B%7Bcookiecutter.project_name%7D%7D/.githooks/pre-commit#L1 This is a handcrafted script which could be replaced with the [https://pre-commit.com/](https://pre-commit.com/)...

Sonar token missing warning when not setup

2

Pushing a generated project to GitHub will trigger the `.github/workflows/sonarcloud.yml` workflow to be run. However Sonar token has not been [setup](https://github.com/NLeSC/python-template/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/project_setup.md#continuous-code-quality) yet then the workflow will fail with a unpleasant...

Use https://github.com/marketplace/actions/github-labeler

Limit number of CI jobs run

2

At * https://github.com/NLeSC/python-template/blob/ce276a6a6ef4d893f2766c08d0df2a608858dc7f/.github/workflows/tests.yml#L4-L6 * https://github.com/NLeSC/python-template/blob/ce276a6a6ef4d893f2766c08d0df2a608858dc7f/.github/workflows/markdown-link-check.yml#L3 * https://github.com/NLeSC/python-template/blob/ce276a6a6ef4d893f2766c08d0df2a608858dc7f/%7B%7Bcookiecutter.project_name%7D%7D/.github/workflows/build.yml#L3 * https://github.com/NLeSC/python-template/blob/ce276a6a6ef4d893f2766c08d0df2a608858dc7f/%7B%7Bcookiecutter.project_name%7D%7D/.github/workflows/cffconvert.yml#L3 * https://github.com/NLeSC/python-template/blob/ce276a6a6ef4d893f2766c08d0df2a608858dc7f/%7B%7Bcookiecutter.project_name%7D%7D/.github/workflows/lint.yml#L3 * https://github.com/NLeSC/python-template/blob/ce276a6a6ef4d893f2766c08d0df2a608858dc7f/%7B%7Bcookiecutter.project_name%7D%7D/.github/workflows/markdown-link-check.yml#L3 * https://github.com/NLeSC/python-template/blob/ce276a6a6ef4d893f2766c08d0df2a608858dc7f/%7B%7Bcookiecutter.project_name%7D%7D/.github/workflows/sonarcloud.yml#L3-L6 2 jobs are triggered when a push is done to a pull request, because the...

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....