Improve linkchecking action

Open
#1,179 8 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions
Domain
ci-cd

Research direction

Start by inspecting the linkchecking action and the workflow that invokes it; the issue gives no file paths or test names. Review the discussion in PR #1175 and identify how the action handles pull requests and installs napari. Done means the action is slimmer and faster, can optionally run locally, and has a clear pull request behavior.

Written by the indexing model from the issue text.

Description

We discussed briefly at the docs meeting and a few ideas:

  1. we would have to restructure this for PRs by not having it open an issue and just failing. Unsure if its currently worth on PRs
  2. Also want to add the option to run this locally.

Originally posted by @TimMonko in https://github.com/napari/docs/pull/1175#pullrequestreview-5621364961

It also installs napari, which is probably unnecessary? Presumably this action can be made much slimmer and faster

Dominant language
Makefile
Stars
13
Forks
71
Avg merge
3d 11h
Merged PRs (30d)
30

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from napari/docs

All issues in napari/docs

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.