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 docstr-coverage badge #1680

Merged
merged 4 commits into from
Jul 9, 2021

Conversation

epassaro
Copy link
Member

Description

Use jsonbin.org RESTFUL API and shields.io endpoint to create a badge for docstr-coverage workflow.

  • The new job will run only when a new commit is pushed to master branch.
  • The new job will NOT run on forks.
  • The old job runs only when a new commit is pushed to a pull request.
  • Fixed the Azure badge.

Motivation and context

Currently we don't have a way to see what's the result of docstr-coverage without running it.

How has this been tested?

  • Testing pipeline.
  • Other.

Tested on my fork. Results uploaded at: https://jsonbin.org/tardis-bot/badges/tardis/docstr-coverage

Examples

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@tardis-bot
Copy link
Contributor

tardis-bot commented Jun 30, 2021

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@codecov
Copy link

codecov bot commented Jun 30, 2021

Codecov Report

Merging #1680 (ce6ca77) into master (7994739) will not change coverage.
The diff coverage is n/a.

❗ Current head ce6ca77 differs from pull request most recent head df6eede. Consider uploading reports for the commit df6eede to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1680   +/-   ##
=======================================
  Coverage   61.26%   61.26%           
=======================================
  Files          63       63           
  Lines        5798     5798           
=======================================
  Hits         3552     3552           
  Misses       2246     2246           

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 7994739...df6eede. Read the comment docs.

Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

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

This is pretty smart - jsonbin.org seems like a useful tool 👍

@andrewfullard
Copy link
Contributor

@epassaro needs the conflict fixed then we can merge

@epassaro epassaro force-pushed the dstr-coverage-badge branch from 1f47d15 to c16e15d Compare July 6, 2021 19:37
@epassaro
Copy link
Member Author

epassaro commented Jul 6, 2021

@epassaro needs the conflict fixed then we can merge

Done.

@epassaro epassaro force-pushed the dstr-coverage-badge branch from c16e15d to df6eede Compare July 7, 2021 17:46
@epassaro epassaro changed the title auto-updatable docstr-coverage badge add docstr-coverage badge Jul 8, 2021
@andrewfullard andrewfullard merged commit b34e626 into tardis-sn:master Jul 9, 2021
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* auto-updatable docstr-coverage badge

* add badge to README.rst

* fix broken azure badge

* change condition before merging
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants