Adding details for auto backport #123
Conversation
Signed-off-by: Vacha Shah <[email protected]>
Signed-off-by: Vacha Shah <[email protected]>
META.md
Outdated
| - [Remaining Plugins](#remaining-plugins) | ||
| - [Update job-scheduler Snapshots](#update-job-scheduler-snapshots) | ||
| - [Update the Manifest](#update-the-manifest) | ||
| - [Backporting in OpenSearch Plugins](#backporting-in-opensearch-plugins) |
There was a problem hiding this comment.
I couldn't find a better place, but Meta.md doesnt feel like the right place to have the backport workflows.
May be https://github.com/opensearch-project/opensearch-plugins/blob/main/STANDARDS.md?
There was a problem hiding this comment.
Yeah you are right. It doesn't look right in META.md. What do you think between STANDARDS.md and CONTRIBUTING.md?
|
I think that the developer part of how to use backporting should go into CONTRIBUTING.md and the admin part of how to set it up should go into https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md - that's where we tell maintainers to enable CI and DCO. |
|
Also, a blog post on adopting backport automation would be great for the blog! |
|
Yes, I am going to work on drafting a blog for this. |
Yep, you're right. |
Signed-off-by: Vacha Shah <[email protected]>
There was a problem hiding this comment.
Really nice work @VachaShah !!
Dropped a minor suggestion, I'm ok merging the PR as is.
|
|
||
| To use the auto backport workflow: | ||
|
|
||
| 1. Label the original PR according to the release-branch. For example, to backport to 1.x , please add a label `backport 1.x`. You can add multiple backport labels to different release branches. Labels can be added in any order: meaning before or after the PR is merged. |
There was a problem hiding this comment.
An example PR would be nice to look at.
There was a problem hiding this comment.
Yeah I added an example after the usage section.
Signed-off-by: Vacha Shah <[email protected]>
Signed-off-by: Vacha Shah [email protected]
Description
Coming from #108 (comment), adding details for auto backport in a
.mdfile.Issues Resolved
[List any issues this PR will resolve]
Check List
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.