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

feat: improve version suggestion checks #4765

Open
Tracked by #1778
pepopowitz opened this issue Dec 12, 2024 · 0 comments
Open
Tracked by #1778

feat: improve version suggestion checks #4765

pepopowitz opened this issue Dec 12, 2024 · 0 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 Dec 12, 2024

Originally part of #1778, but extracted so that I could close that issue.

We have a check (check-versions) that makes suggestions about versions being edited in a PR. We could enhance the logic to be a little smarter, including:

  • Skip suggestions if a future-version is applied (e.g. target:8.x where 8.x is the next release). In this case, the changes are usually for unreleased features, and don't need to be backported.
  • 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. It's unusual that we edit an older version of the docs in isolation.
@pepopowitz pepopowitz changed the title Skip suggestions if a future-version is applied (e.g. target:8.4) feat: enhance version suggestion checks Dec 12, 2024
@pepopowitz pepopowitz changed the title feat: enhance version suggestion checks feat: improve version suggestion checks Dec 12, 2024
@pepopowitz pepopowitz self-assigned this Dec 12, 2024
@pepopowitz pepopowitz added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team labels Dec 12, 2024
@pepopowitz pepopowitz moved this to 🆕 Inbox 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: 🆕 Inbox
Development

No branches or pull requests

1 participant