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

Add backport documentation link #161

Merged
merged 2 commits into from
Mar 9, 2022

Conversation

annie3431
Copy link
Contributor

Signed-off-by: Annie Lee leeyun@amazon.com

Description

Add the backport workflow documentation

Issues Resolved

#135

Check List

  • Commits are signed per the DCO using --signoff

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.

Signed-off-by: Annie Lee <leeyun@amazon.com>
@annie3431 annie3431 requested a review from a team March 8, 2022 19:31
@annie3431 annie3431 added backport 1.x documentation Improvements or additions to documentation labels Mar 8, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #161 (cbb4612) into main (2de6e3b) will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #161      +/-   ##
==========================================
+ Coverage   63.38%   63.40%   +0.01%     
==========================================
  Files         155      155              
  Lines        4419     4432      +13     
  Branches      690      691       +1     
==========================================
+ Hits         2801     2810       +9     
- Misses       1402     1407       +5     
+ Partials      216      215       -1     
Impacted Files Coverage Δ
...s/CreateTransform/components/Schedule/Schedule.tsx 90.90% <0.00%> (-9.10%) ⬇️
...ainers/CreateTransformForm/CreateTransformForm.tsx 58.22% <0.00%> (-0.58%) ⬇️
...es/Transforms/containers/Transforms/Transforms.tsx 70.49% <0.00%> (ø)
...sform/components/ReviewSchedule/ReviewSchedule.tsx 80.00% <0.00%> (ø)
...ainers/ReviewAndCreateStep/ReviewAndCreateStep.tsx 90.00% <0.00%> (ø)
...ainers/SpecifyScheduleStep/SpecifyScheduleStep.tsx 47.50% <0.00%> (ø)
...nsforms/containers/Transforms/TransformDetails.tsx 75.65% <0.00%> (+0.43%) ⬆️
...n/public/pages/Transforms/utils/metadataHelper.tsx 72.41% <0.00%> (+2.04%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2de6e3b...cbb4612. Read the comment docs.

BACKPORT.md Outdated
2. The backport workflow is now created by a Github App called `opensearch-trigger-bot` instead of `github-actions` which allows CI to run on such PRs.
3. The backport branches are named in the form `backport/backport-<original PR number>-to-<base>`. These branches will be cleaned up by an auto delete workflow once the backport PR is merged.

### Integration
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems odd to include this no? I would assume we would just want documentation on how to utilize the backporting mechanism with a link/reference to this equivalent doc in the opensearch plugins repository.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I think this can be changed to a link in developer_guide or README file

Signed-off-by: Annie Lee <leeyun@amazon.com>
@annie3431 annie3431 changed the title Add BACKPORT.md Add backport documentation link Mar 9, 2022
@annie3431 annie3431 requested review from bowenlan-amzn and a team March 9, 2022 01:18
@annie3431 annie3431 merged commit f69b5fe into opensearch-project:main Mar 9, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 9, 2022
* Create BACKPORT.md

Signed-off-by: Annie Lee <leeyun@amazon.com>

* Remove backport documentation file and replace with a link

Signed-off-by: Annie Lee <leeyun@amazon.com>
(cherry picked from commit f69b5fe)
downsrob pushed a commit to downsrob/index-management-dashboards-plugin that referenced this pull request Mar 9, 2022
* Create BACKPORT.md

Signed-off-by: Annie Lee <leeyun@amazon.com>

* Remove backport documentation file and replace with a link

Signed-off-by: Annie Lee <leeyun@amazon.com>
Signed-off-by: Robert Downs <downsrob@amazon.com>
downsrob added a commit that referenced this pull request Mar 9, 2022
* Create backport workflow  (#148)

* Create backport.yml

Signed-off-by: Annie Lee <leeyun@amazon.com>

* Create delete_backport_branch.yml

Signed-off-by: Annie Lee <leeyun@amazon.com>
Signed-off-by: Robert Downs <downsrob@amazon.com>

* Adds support for creating and displaying the transform continuous mode (#153)

* Adds continuous transform mode display and create

Signed-off-by: Robert Downs <downsrob@amazon.com>

* Adds release note

Signed-off-by: Clay Downs <89109232+downsrob@users.noreply.github.com>
Signed-off-by: Robert Downs <downsrob@amazon.com>

* Adds support on UI for min primary shard size rollover condition and min rollover age transition condition (#159)

* Adds the min primary shard size condition in rollover UI

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>

* Removes validation for rollover action that requires at least one condition since backend supports no conditions

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>

* Removes empty rollover conditions in default rollover JSON thats making the create policy fail when sending to backend

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>

* Adds UI support for min rollover age in the transition UI

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>

* Updates jest snapshots for create transition and create action

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>
Signed-off-by: Robert Downs <downsrob@amazon.com>

* Add backport documentation link  (#161)

* Create BACKPORT.md

Signed-off-by: Annie Lee <leeyun@amazon.com>

* Remove backport documentation file and replace with a link

Signed-off-by: Annie Lee <leeyun@amazon.com>
Signed-off-by: Robert Downs <downsrob@amazon.com>

* Updates release notes with new commits (#163)

Signed-off-by: Robert Downs <downsrob@amazon.com>

Co-authored-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>
Co-authored-by: Annie Lee <leeyun@amazon.com>
bowenlan-amzn pushed a commit that referenced this pull request May 9, 2022
* Create backport workflow  (#148)

* Create backport.yml

Signed-off-by: Annie Lee <leeyun@amazon.com>

* Create delete_backport_branch.yml

Signed-off-by: Annie Lee <leeyun@amazon.com>
Signed-off-by: Robert Downs <downsrob@amazon.com>

* Adds support for creating and displaying the transform continuous mode (#153)

* Adds continuous transform mode display and create

Signed-off-by: Robert Downs <downsrob@amazon.com>

* Adds release note

Signed-off-by: Clay Downs <89109232+downsrob@users.noreply.github.com>
Signed-off-by: Robert Downs <downsrob@amazon.com>

* Adds support on UI for min primary shard size rollover condition and min rollover age transition condition (#159)

* Adds the min primary shard size condition in rollover UI

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>

* Removes validation for rollover action that requires at least one condition since backend supports no conditions

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>

* Removes empty rollover conditions in default rollover JSON thats making the create policy fail when sending to backend

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>

* Adds UI support for min rollover age in the transition UI

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>

* Updates jest snapshots for create transition and create action

Signed-off-by: Drew Baugher <dbbaughe@amazon.com>
Signed-off-by: Robert Downs <downsrob@amazon.com>

* Add backport documentation link  (#161)

* Create BACKPORT.md

Signed-off-by: Annie Lee <leeyun@amazon.com>

* Remove backport documentation file and replace with a link

Signed-off-by: Annie Lee <leeyun@amazon.com>
Signed-off-by: Robert Downs <downsrob@amazon.com>

* Updates release notes with new commits (#163)

Signed-off-by: Robert Downs <downsrob@amazon.com>

Co-authored-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>
Co-authored-by: Annie Lee <leeyun@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.x documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants