chore: Split Docs CI from core CI #17897
Conversation
✅ Deploy Preview for docs-eslint canceled.
|
snitin315
added
the
accepted
|
Only doubt I have is we have added paths for the docs CI. Should we consider excluding the docs in the normal one then? Just in case: |
Some checks verify consistency between code and docs, so either change should trigger them and thus we'd need to split checks into more than 2 sets. |
.github/workflows/ci.yml
Outdated
| - name: Lint Docs JS Files | ||
| run: node Makefile lintDocsJS | ||
| - name: Check Rule Examples | ||
| run: node Makefile checkRuleExamples |
There was a problem hiding this comment.
I'm not sure about these two. A change in our eslint config or in the tool that checks rule examples can cause these checks to fail. But those changes are not in docs/** so they wouldn't trigger these checks and so the failures might go unnoticed until someone submits a PR that changes something in the docs.
Maybe only those tasks that run in working-directory: docs can be safely extracted into a separate CI?
|
There are merge conflicts now. |
.github/workflows/docs-ci.yml
Outdated
| push: | ||
| branches: [main] | ||
| paths: | ||
| - 'docs/**' | ||
|
|
||
| pull_request: | ||
| branches: [main] | ||
|
|
There was a problem hiding this comment.
Shouldn't we also add the same paths for pull_request?
* main: chore: Split Docs CI from core CI (eslint#17897) fix: Ensure config keys are printed for config errors (eslint#17980) chore: delete relative-module-resolver.js (eslint#17981) docs: migration guide entry for `no-inner-declarations` (eslint#17977) docs: Update README feat: maintain latest ecma version in ESLint (eslint#17958) feat!: no-inner-declaration new default behaviour and option (eslint#17885) feat: add `no-useless-assignment` rule (eslint#17625) fix: `no-misleading-character-class` edge cases with granular errors (eslint#17970) feat: `no-misleading-character-class` granular errors (eslint#17515) docs: fix number of code-path events on custom rules page (eslint#17969) docs: reorder entries in v9 migration guide (eslint#17967) fix!: handle `--output-file` for empty output when saving to disk (eslint#17957)
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:
CI update
What changes did you make? (Give an overview)
This is an attempt to split out the docs-related CI from everything else to help non-docs-related PRs finish their CI faster.
I've split out the docs-related CI tasks into a separate workflow that only runs when files are updated in the
docs/directory.Is there anything you'd like reviewers to focus on?
Did I miss anything?