Add a link to the flakey test dev guide.

[dblock]

Signed-off-by: Daniel (dB.) Doubrovkine [email protected]

Description

Added some text to help the contributor with next steps on CI failures.

Issues Resolved

Closes #4871.

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.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: SUCCESS ✅
• URL: https://build.ci.opensearch.org/job/gradle-check/5213/
• CommitID: b418ec0

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/5214/
• CommitID: 844722d

[codecov-commenter]

Codecov Report

Merging #4872 (b418ec0) into main (3af46ae) will decrease coverage by 0.05%.
The diff coverage is 62.50%.

❗ Current head b418ec0 differs from pull request most recent head 844722d. Consider uploading reports for the commit 844722d to get more accurate results

@@             Coverage Diff              @@
##               main    #4872      +/-   ##
============================================
- Coverage     70.70%   70.65%   -0.06%     
+ Complexity    57896    57388     -508     
============================================
  Files          4689     4576     -113     
  Lines        277137   274896    -2241     
  Branches      40313    40288      -25     
============================================
- Hits         195947   194223    -1724     
+ Misses        64987    64456     -531     
- Partials      16203    16217      +14     

Impacted Files	Coverage Δ
...main/java/org/opensearch/plugins/SearchPlugin.java	76.92% <ø> (ø)
.../main/java/org/opensearch/search/SearchModule.java	96.24% <ø> (-0.51%)	⬇️
...earch/search/aggregations/InternalAggregation.java	82.71% <ø> (+4.93%)	⬆️
...arch/search/aggregations/InternalAggregations.java	76.47% <0.00%> (+1.96%)	⬆️
...egations/pipeline/AvgBucketPipelineAggregator.java	73.33% <ø> (ø)
...ions/pipeline/BucketMetricsPipelineAggregator.java	75.00% <ø> (+14.28%)	⬆️
...tions/pipeline/BucketScriptPipelineAggregator.java	60.78% <ø> (ø)
...ons/pipeline/BucketSelectorPipelineAggregator.java	0.00% <ø> (ø)
...gations/pipeline/BucketSortPipelineAggregator.java	0.00% <ø> (ø)
...ions/pipeline/CumulativeSumPipelineAggregator.java	73.07% <ø> (ø)
... and 835 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/5247/
• CommitID: 844722d

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/5350/
• CommitID: cf3856a

[dblock]

org.opensearch.repositories.s3.RepositoryS3ClientYamlTestSuiteIT > test {yaml=repository_s3/20_repository_permanent_credentials/Snapshot and Restore with repository-s3 using permanent credentials} FAILED
    java.lang.AssertionError: Failure at [repository_s3/20_repository_permanent_credentials:152]: expected [2xx] status code but api [snapshot.create] returned [400 Bad Request] [{"error":{"root_cause":[{"type":"invalid_snapshot_name_exception","reason":"[repository_permanent:snapshot-one] Invalid snapshot name [snapshot-one], snapshot with the same name already exists","stack_trace":"InvalidSnapshotNameException[[rep

#2064

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/5365/
• CommitID: cf3856a

[dblock]

Again

 - org.opensearch.repositories.s3.RepositoryS3ClientYamlTestSuiteIT.test {yaml=repository_s3/20_repository_permanent_credentials/Try to create repository with broken endpoint override and named client}

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: UNSTABLE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/5395/
• CommitID: cf3856a

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: SUCCESS ✅
• URL: https://build.ci.opensearch.org/job/gradle-check/5405/
• CommitID: 1cf766c

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-4872-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 67a29dff7a1f72abf7295360bd541d1cd0155f73
# Push it to GitHub
git push --set-upstream origin backport/backport-4872-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-4872-to-2.x.

[peterzhuamazon]

@dblock please add this to 1.x and 1.3 as well.

Thanks.

[opensearch-trigger-bot]

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.x 1.x
# Navigate to the new working tree
cd .worktrees/backport-1.x
# Create a new branch
git switch --create backport/backport-4872-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 67a29dff7a1f72abf7295360bd541d1cd0155f73
# Push it to GitHub
git push --set-upstream origin backport/backport-4872-to-1.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.x

Then, create a pull request where the base branch is 1.x and the compare/head branch is backport/backport-4872-to-1.x.

[opensearch-trigger-bot]

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.3 1.3
# Navigate to the new working tree
cd .worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-4872-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 67a29dff7a1f72abf7295360bd541d1cd0155f73
# Push it to GitHub
git push --set-upstream origin backport/backport-4872-to-1.3
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-4872-to-1.3.

[dblock]

@dblock please add this to 1.x and 1.3 as well.

Thanks.

Will do. I think I want to edit this a bit on main first.