canonical / canonical/sphinx-stack

Vale should only run on the diff

Open
#629 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
No language data
Stars
37
Forks
77
Avg merge
1d 5h
Merged PRs (30d)
3

Description

Raised by @shaloo
> I also noticed that our PR workflows run vale on the entire doc-set! That is a waste of resource /time instead of just running spelling checks on the diff/changes.

Contributor guide

Open the contributing guide

Research direction

Locate the pull-request workflow that invokes Vale and inspect how its document set is selected. Update the workflow so Vale checks only the diff or changed documentation, then verify that unchanged documents are no longer included in the PR check.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.