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

[FEATURE] Release branch code coverage details #90

Closed
prudhvigodithi opened this issue Oct 22, 2024 · 1 comment
Closed

[FEATURE] Release branch code coverage details #90

prudhvigodithi opened this issue Oct 22, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@prudhvigodithi
Copy link
Member

prudhvigodithi commented Oct 22, 2024

Is your feature request related to a problem?

Coming from central release dashboard #51, have a visualization in central release dashboard to able to see the Release branch code coverage scores.

What solution would you like?

  • Use the code coverage API.
  • Filter per repo and branch.
  • Take the completed run from the latest head commit.
  • Get the Code coverage score.

Example https://api.codecov.io/api/v2/github/opensearch-project/repos/index-management/commits?branch=main

Do you have any additional context?

  • Some of the repos the code coverage timestamp is older even while the repo is active.
  • The coverage shown is for the older commit even though the head commit is different.

Acceptance Criteria

  • Onboard the code coverage metrics for repos participating in the release, the code already has a logic to use the input manifest, re-use this logic.

  • Implement a mechanism to integrate with existing release metrics and the central release dashboard. Add shared keys that are part of other release metric indices to enable a common filter across all documents and indices, including Codecov data.

  • Handle cases where Codecov returns a null commit ID, null coverage, or missing data, as repositories do not always upload or publish coverage for the latest commits or pull requests.

  • Instead erroring with null data, handle the state with no-coverage, the commitID as noneandcoverageto0.0`

"_source": {
    "coverage": 0,
    "current_date": "2024-10-28T17:54:41.742113549",
    "component": "OpenSearch",
    "id": "09c026db-49b3-3502-ae80-717c6db4b8e1",
    "commitid": "none",
    "state": "no-coverage",
    "repository": "OpenSearch",
    "release_version": "2.18.0",
    "release_state": "open",
    "version": "2.18.0",
    "branch": "2.18",
    "url": "https://api.codecov.io/api/v2/github/opensearch-project/repos/OpenSearch/commits?branch=2.18"
  },
@prudhvigodithi prudhvigodithi added enhancement New feature or request untriaged Issues that have not yet been triaged labels Oct 22, 2024
@prudhvigodithi prudhvigodithi self-assigned this Oct 22, 2024
@prudhvigodithi prudhvigodithi changed the title [FEATURE] Release branch code coverage scores [FEATURE] Release branch code coverage details Oct 22, 2024
@prudhvigodithi prudhvigodithi removed the untriaged Issues that have not yet been triaged label Oct 22, 2024
@prudhvigodithi prudhvigodithi moved this from 🆕 New to 🏗 In progress in Engineering Effectiveness Board Oct 29, 2024
@prudhvigodithi
Copy link
Member Author

prudhvigodithi commented Nov 4, 2024

The codecov metrics is now flowing in Dashboard Discover Link.

The visualization is part of OpenSearch Component Release Metrics dashboard.

Image

Thank you
@getsaurabh02

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: ✅ Done
Development

No branches or pull requests

1 participant