Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Detect missing versions in PR changes #1778

Closed
4 tasks done
Tracked by #1742
pepopowitz opened this issue Mar 6, 2023 · 3 comments
Closed
4 tasks done
Tracked by #1742

Detect missing versions in PR changes #1778

pepopowitz opened this issue Mar 6, 2023 · 3 comments
Assignees
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)

Comments

@pepopowitz
Copy link
Collaborator

pepopowitz commented Mar 6, 2023

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:

  • if vCurrent is affected, but vNext is not, suggest that the changes should also be applied to vNext
  • if vNext is affected, but vCurrent is not, suggest that the changes should also be applied to vCurrent
  • these rules apply to both the "docs" instance and the "optimize" instance

Iteration 2:

Per #2922 (comment), the following rules would also be meaningful:

  • if vPrevious (or older) is affected, but vPrevious+1 through vNext are not, suggest that the changes should also be applied to vPrevious+1 though vNext.

Implementation

Implementation

Preview Give feedback
  1. hold
    pepopowitz
  2. component:docs dx
    pepopowitz
  3. component:docs dx
    pepopowitz
  4. dx kind/bug
    pepopowitz

Tasks extracted from this one

@pepopowitz pepopowitz added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) dx Documentation infrastructure typically handled by the Camunda DX team labels Mar 6, 2023
@pepopowitz pepopowitz self-assigned this Mar 6, 2023
@pepopowitz pepopowitz moved this to 🔖 Ready in Developer Experience Mar 6, 2023
@pepopowitz pepopowitz moved this from 🔖 Ready to 📋 Backlog in Developer Experience Mar 6, 2023
@pepopowitz pepopowitz added the component:docs Documentation improvements, including new or updated content label Mar 6, 2023
@pepopowitz pepopowitz moved this from 📋 Backlog to 🔖 Ready in Developer Experience Apr 17, 2023
@pepopowitz
Copy link
Collaborator Author

Status: Currently collecting feedback of a prototype at #2922.

@pepopowitz pepopowitz moved this from 🔖 Ready to 👀 In Review in Developer Experience Nov 17, 2023
@pepopowitz pepopowitz moved this from 👀 In Review to 🏗 In Progress in Developer Experience Nov 30, 2023
@pepopowitz
Copy link
Collaborator Author

Status: First implementation is up at #3091. I'll let it sit over the holidays, and hope to merge it prior to our release in January.

@pepopowitz pepopowitz moved this from 🏗 In Progress to 🛑 Blocked in Developer Experience Apr 4, 2024
@pepopowitz
Copy link
Collaborator Author

I've extracted the remaining work on this one, so that I can mark this done.

@github-project-automation github-project-automation bot moved this from 🛑 Blocked to ✅ Done in Developer Experience Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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)
Projects
Status: ✅ Done
Development

No branches or pull requests

1 participant