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

docs: Improve badge layout and fix broken Docker badge #1497

Merged
merged 3 commits into from
Jun 21, 2021

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Jun 21, 2021

Description

Resolves #1361

The old Docker deployment badge is now broken,

badge

so fix it by using the GitHub Actions stats badge. Also reorder badges for user convince over developer convenience.

Current layout

current_layout

PR layout

badge_layout

@phinate we'll merge this before you can probably look at it, but feedback and future revision suggestions are welcome.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Update broken Docker deployment badge with GitHub Actions Docker workflow status badge
* Remove Docker stars and pulls badges
* Add pyhf CUDA enabled Docker images badge
* Revise badge layout to prioritize user needs (docs and distributions) over developer interests (code quality and CI status)

@matthewfeickert matthewfeickert added the docs Documentation related label Jun 21, 2021
@matthewfeickert matthewfeickert self-assigned this Jun 21, 2021
@codecov
Copy link

codecov bot commented Jun 21, 2021

Codecov Report

Merging #1497 (20ec345) into master (ccc32c1) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1497   +/-   ##
=======================================
  Coverage   97.65%   97.65%           
=======================================
  Files          63       63           
  Lines        4006     4006           
  Branches      565      565           
=======================================
  Hits         3912     3912           
  Misses         55       55           
  Partials       39       39           
Flag Coverage Δ
contrib 25.51% <ø> (ø)
unittests 97.42% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


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 ccc32c1...20ec345. Read the comment docs.

@matthewfeickert matthewfeickert changed the title docs: Fix badge placement and broken Docker deployment badge docs: Improve badge layout and fix broken Docker badge Jun 21, 2021
@matthewfeickert matthewfeickert added the fix A bug fix label Jun 21, 2021
@matthewfeickert matthewfeickert merged commit 302af0b into master Jun 21, 2021
@matthewfeickert matthewfeickert deleted the docs/fix-badge-placement branch June 21, 2021 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related fix A bug fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Placement of badges at top of repo for clarity
1 participant