Skip to content

Codify the simplified branching strategy in RELEASING.md#303

Merged
mch2 merged 1 commit intoopensearch-project:mainfrom
andrross:branching
Apr 2, 2025
Merged

Codify the simplified branching strategy in RELEASING.md#303
mch2 merged 1 commit intoopensearch-project:mainfrom
andrross:branching

Conversation

@andrross
Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andrross thanks for writing this up two overall considerations:

  1. Have the maintainers of OpenSearch-build weighted in on what changes will need to be made (if any) to support this update?

  2. 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.

@andrross
Copy link
Copy Markdown
Member Author

Have the maintainers of OpenSearch-build weighted in on what changes will need to be made (if any) to support this update?

@peternied Yes. See #251, or this comment more specifically regarding opensearch-build.

Rather than rewriting this section what do you think of removing the branching documentation from the project-wide guidance ... 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.

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.

@peternied
Copy link
Copy Markdown
Member

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.

peternied
peternied previously approved these changes Mar 19, 2025
dblock
dblock previously approved these changes Mar 20, 2025
Signed-off-by: Andrew Ross <andrross@amazon.com>
@andrross andrross dismissed stale reviews from dblock and peternied via aa31d66 March 20, 2025 16:35
@mch2 mch2 merged commit 954b4e5 into opensearch-project:main Apr 2, 2025
3 checks passed
@andrross andrross deleted the branching branch April 2, 2025 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[PROPOSAL] Simplify OpenSearch distribution branching strategy

4 participants