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

Don't overwrite stable release docs with unstable/release candidate docs #143

Open
huonw opened this issue Feb 5, 2024 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@huonw
Copy link
Contributor

huonw commented Feb 5, 2024

For "branches" that have a stable release, we probably shouldn't sync the docs for future release candidates on that branch, only future stable releases. E.g., we've released 2.19.0 and therefore:

  • when we release 2.19.1rc123 or similar, don't sync doc changes ❌ , as that would replace the stable docs with unstable/unreleased info
  • when we release 2.19.1, sync the doc changes ✅
  • (when we release 2.20.0rc123 or similar, sync the doc changes ✅ because there hasn't been a stable release)

For now, we can have a convention of a human deciding to merge or not merge the doc sync PR as appropriate, but it be better for the automation to handle it automatically.

see https://chat.pantsbuild.org/t/16370494/i-assume-we-should-not-be-listing-2-17-and-2-16-as-prereleas#ad27355f-9e63-4210-839f-6a421ff0f44f

@huonw
Copy link
Contributor Author

huonw commented Feb 13, 2024

Potentially in direct tension with #148.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant