docs/react-v9/contributing/rfcs/future/prevent-ci-trigger-on-doc-prs.md
Contributors: @andrefcdias
The purpose of this RFC is to find a solution to avoid unnecessary GitHub checks from running on PRs that only affect documentation to avoid wasteful resource usage and improve our DX.
Whenever someone creates a PR, independently of the content, the CI is triggered and added as a check for a successfull PR. This, along with Screener and CodeSandbox, is consuming unnecessary resources on our pipeline for, essentially, no reason.
Apart from this, other PRs that actually need CI checks, will be delayed due to the lack of parallelism in our pipeline. By avoiding these checks, we can prevent a wasteful CI pipeline and accelerate work in PRs that bring value to our users.
The agreed solution is to extract our Wiki into its own separate repository and linking it with the fluentui repo wiki. This will allow us to avoid the issue altogether and even implement our own checks (like running Prettier as @layershifter suggested) with minimum effort.
Implementation would cover the following:
And this details the new workflow mentioned above:
Moving docs directly to the wiki repo;
There is unfortunately no way of creating PRs for changes in the Wiki repo.
Avoiding the GitHub checks in our CI by excluding doc paths
Due to the branch protection rules, we are unable to avoid the execution of required checks. Another limitation is our current tooling (no ability to implement content aware pipeline). CodeSandbox also did not support this at the time of writing this. Upon contacting their support, they added it to their backlog as a possible future feature.
N/A