Detect missing versions in PR changes #1778
Labels
component:docs
Documentation improvements, including new or updated content
dx
Documentation infrastructure typically handled by the Camunda DX team
kind/enhancement
Issues related with enhancing existing documentation or the documentation structure (nice to have)
Part of #1742
Currently it is left up to humans to notice when a PR's changes affect one version of the docs but should likely be synchronized to another version. This results in PRs merging prematurely, and requiring follow-up PRs when someone notices that it should be synchronized to another version.
We should write a GitHub action that looks at the files changed, and based on the rules below, comments on the PR if changes are likely to need synchronization.
Note that the comment should be worded as a suggestion -- there will always be cases where a change is intended in only one version, and we should still allow for those changes to happen.
Version synchronization suggestion rules
Iteration 1:
Iteration 2:
Per #2922 (comment), the following rules would also be meaningful:
Implementation
Implementation
current
but notnext
, and vice-versa. #2922Tasks extracted from this one
The text was updated successfully, but these errors were encountered: