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

Update the DEVELOPER_GUIDE.md to add Gradle Check Metrics Dashboard details #13919

Merged
merged 1 commit into from
Jun 1, 2024

Conversation

prudhvigodithi
Copy link
Member

@prudhvigodithi prudhvigodithi commented May 31, 2024

Description

Coming from #11217 (comment) and #11217 (comment) update the DEVELOPER_GUIDE.md to add Gradle Check Metrics Dashboard details.

Related Issues

Part of #11217

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • API changes companion pull request created.
  • Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
  • Commits are signed per the DCO using --signoff
  • [ ]Commit changes are listed out in CHANGELOG.md file (See: Changelog)
  • Public documentation issue/PR created

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.

@reta
Copy link
Collaborator

reta commented May 31, 2024

@andrross @prudhvigodithi I think it belongs to CONTRIBUTING.md more, since the DEVELOPER_GUIDE.md is all about local development, and not shared CI infra (like Jenkins, GA checks, etc) or README.md

@prudhvigodithi
Copy link
Member Author

Hey @reta the DEVELOPER_GUIDE.md already has information about the flaky tests that has the details mentioning about the CI checks and gradle workflows. The idea of this PR is ensure developers are aware of this OpenSearch Gradle Check Metrics Dashboard to help investigate the flaky failures and resolve them, so more than CONTRIBUTING.md, the DEVELOPER_GUIDE.md seems to be like the right place for this information.

@andrross
Copy link
Member

andrross commented Jun 1, 2024

Yeah, I think this works well alongside the "Flaky Tests" subheading in the developer guide. I'm going to merge this as-is, but we can always iterate and improve on the documentation as needed. Thanks!

@andrross andrross merged commit 771f4ec into opensearch-project:main Jun 1, 2024
28 checks passed
@andrross andrross added the backport 2.x Backport to 2.x branch label Jun 1, 2024
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

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

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-13919-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 771f4ec2e4daebf04f9d94e6d8268a6b57b1b857
# Push it to GitHub
git push --set-upstream origin backport/backport-13919-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

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

akolarkunnu pushed a commit to akolarkunnu/OpenSearch that referenced this pull request Jun 3, 2024
parv0201 pushed a commit to parv0201/OpenSearch that referenced this pull request Jun 10, 2024
wdongyu pushed a commit to wdongyu/OpenSearch that referenced this pull request Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants