Codify the simplified branching strategy in RELEASING.md#303
Codify the simplified branching strategy in RELEASING.md#303mch2 merged 1 commit intoopensearch-project:mainfrom
Conversation
peternied
left a comment
There was a problem hiding this comment.
@andrross thanks for writing this up two overall considerations:
-
Have the maintainers of OpenSearch-build weighted in on what changes will need to be made (if any) to support this update?
-
Rather than rewriting this section what do you think of removing the branching documentation from the project-wide guidance and author this branch policy as part of the specific documentation for being part of the OpenSearch distribution?
When this documentation was originally written it was about formalizing a unified plan - mostly for the purposes of getting core & plugin teams aligned. With this new update it seems like we are getting close to letting individual repos be ruled by what works best for them conventions rather than a policy for the entire project. With more and more projects being added that are related, but not tied to the OpenSearch distribution the utility of the section seems diffuse.
@peternied Yes. See #251, or this comment more specifically regarding opensearch-build.
The existing documentation defines the branching strategy for the distribution (albeit spread across two sections "OpenSearch and OpenSearch Dashboards Branching" and "Plugin Branching") and then the "Single Repo Artifacts Branching" section says that those repos follow a different strategy (i.e. what works best for them). This update isn't changing the structure of that. It's just changing the distribution branching strategy (and restructuring the sections to hopefully make things more clear). We don't have to define the distribution strategy here as it is not truly project-wide. But if we don't define it here, where would you suggest that it go? It could go in opensearch-build, but my fear is that not too many folks turn to that repo as a source of documentation. |
I'm not sure that this repo is any better for discoverability, but we've already got it here 🤷 . If you are fine with the overhead of making changes in this repo with additional process - that is fine with me. |
Signed-off-by: Andrew Ross <andrross@amazon.com>
Issues Resolved
Resolves #251
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.