Work around spelling exceptions added to release-next#591
Conversation
|
Skipping CI for Draft Pull Request. |
ec648bb to
cf89afa
Compare
irbekrm
left a comment
There was a problem hiding this comment.
Looks good to me and makes sense- I have added a tiny nit that you can also ignore 😅
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: irbekrm, maelvls The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Looks good to me, I've added a small nit, but do unhold if you'd rather merge. /hold |
Signed-off-by: Maël Valais <mael@vls.dev>
cf89afa to
09f3762
Compare
|
Looks good to me! Thanks for fixing this. /hold cancel |
The problem
Whenever we run
mdspell, we first clone every branch (release-1.3, release-1.4, release-next...) into thecontent/en/docs/folder.When words are added to the release-next branch and aren't on master yet, master fails due to the yet-to-be-ignored words are unknown to
mdspell.As an example, the PR #570 added the new spellings "andreas-p" and "renewBefore" to the release-next branch. After the merge, all builds on master started failing since "andreas-p" and "renewBefore" were not present on the master branch's .spelling file.
Idea 1 (this PR)
Ignore spelling of release-next. PRs merged to release-next already have no spelling mistake, so we don't really need to enforce the spelling again.
Idea 2
Use mdspell's
--target-relativewhich requires copying the.spellingfile from the release-next branch and copy it intocontent/en/next-docs. After looking at verify-lint, one way could be to have a new flag to hugo-multiversion, e.g.,./scripts/bin/multiversion" \ --repo-url https://github.com/cert-manager/website.git \ --repo-content-dir content/en/docs \ + --repo-content-extra-file .spelling \ --output-dir "${REPO_ROOT}/content/en" \ --branches v0.13-docs=release-0.13 \ --branches v0.12-docs=release-0.12 \ --branches next-docs=release-nextNot sure what is the right solution 😅
cc @irbekrm @munnerz