Add project health badges #4843
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
peternied
commented
Oct 19, 2022
README.md
Outdated
Comment on lines
6
to
9
| [](https://github.com/opensearch-project/OpenSearch/actions/workflows/gradle-check.yml) | ||
| [](https://github.com/opensearch-project/OpenSearch/actions/workflows/wrapper.yml) | ||
| [](https://github.com/opensearch-project/OpenSearch/actions/workflows/precommit.yml) | ||
| [](https://build.ci.opensearch.org/job/gradle-check/) |
There was a problem hiding this comment.
These existing badge aren't very actionable for the prime real estate on this page.
There was a problem hiding this comment.
True, may be those are not actionable, but may be those added as quick links similar to the documentation badge. @dreamer-89 what is your thought?
There was a problem hiding this comment.
Yes, the existing badges provides status and quick links to related workflow/job.
@dblock : what are you thoughts on this ?
There was a problem hiding this comment.
Sounds like 2 people find them useful @peternied, I would put those back.
There was a problem hiding this comment.
@dreamer-89 I've added them back what do you think of their placement?
Screenshot
There was a problem hiding this comment.
Thanks @peternied for this change.
The overall layout looks good to me.
README.md
Outdated
| [](https://github.com/opensearch-project/opensearch/pulls) | ||
| [](https://app.codecov.io/gh/opensearch-project/opensearch) | ||
| [](https://github.com/opensearch-project/opensearch/issues?q=is%3Aissue+is%3Aopen+label%3A"v2.4.0") | ||
| [](https://github.com/opensearch-project/opensearch/issues?q=is%3Aissue+is%3Aopen+label%3A"v3.0.0") | ||
|
|
||
| - [Welcome!](#welcome) |
There was a problem hiding this comment.
Click here to see the readme with this changes.
anasalkouz
requested changes
Oct 19, 2022
README.md
Outdated
Comment on lines
6
to
9
| [](https://github.com/opensearch-project/OpenSearch/actions/workflows/gradle-check.yml) | ||
| [](https://github.com/opensearch-project/OpenSearch/actions/workflows/wrapper.yml) | ||
| [](https://github.com/opensearch-project/OpenSearch/actions/workflows/precommit.yml) | ||
| [](https://build.ci.opensearch.org/job/gradle-check/) |
There was a problem hiding this comment.
True, may be those are not actionable, but may be those added as quick links similar to the documentation badge. @dreamer-89 what is your thought?
Gradle Check (Jenkins) Run Completed with:
|
Codecov Report
@@ Coverage Diff @@
## main opensearch-project/opensearch-build#4843 +/- ##
============================================
- Coverage 70.83% 70.78% -0.05%
+ Complexity 57884 57879 -5
============================================
Files 4689 4689
Lines 276913 276913
Branches 40301 40301
============================================
- Hits 196141 196015 -126
- Misses 64499 64624 +125
- Partials 16273 16274 +1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
dblock
approved these changes
Oct 21, 2022
Signed-off-by: Peter Nied <petern@amazon.com>
Signed-off-by: Peter Nied <petern@amazon.com>
Signed-off-by: Peter Nied <petern@amazon.com>
Signed-off-by: Peter Nied <petern@amazon.com>
peternied
force-pushed
the
readme-badges
branch
from
559f7ab
to
6ba277d
Compare
|
@anasalkouz @dreamer-89 What do you think? |
Gradle Check (Jenkins) Run Completed with:
|
dblock
approved these changes
Oct 24, 2022
Gradle Check (Jenkins) Run Completed with:
|
anasalkouz
approved these changes
Oct 24, 2022
Gradle Check (Jenkins) Run Completed with:
|
ashking94
pushed a commit
to ashking94/OpenSearch
that referenced
this pull request
Nov 7, 2022
* Add project health badges Signed-off-by: Peter Nied <petern@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding badges indicative of project health
Issues Resolved
Check List
New functionality includes testing.All tests passNew functionality has been documented.New functionality has javadoc addedBy 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.