search

drivendataorg / nbautoexport

Automatically export Jupyter notebooks to various file formats (.py, .html, and more) on save.
https://nbautoexport.drivendata.org/
MIT License
72 stars 9 forks source link

Add deploy badge for docs #47

Closed pjbull closed 4 years ago

pjbull commented 4 years ago

Tried adding the badge from netlify, but seems like the badge does not accurately reflect GH Action builds. Will look in to updating with a badge that works.

The cooler part is I setup the DNS for nbautoexport.drivendata.org

github-actions[bot] commented 4 years ago

🚀 Deployed on https://deploy-preview-47--zen-roentgen-1e5a72.netlify.app

codecov[bot] commented 4 years ago

Codecov Report

Merging #47 into master will not change coverage. The diff coverage is n/a.

@@          Coverage Diff           @@
##           master     #47   +/-   ##
======================================
  Coverage    98.1%   98.1%           
======================================
  Files           8       8           
  Lines         371     371           
======================================
  Hits          364     364           
  Misses          7       7
Impacted Files Coverage Δ
nbautoexport/sentinel.py 100.0% <0.0%> (ø)
nbautoexport/nbautoexport.py 98.2% <0.0%> (ø)
jayqi commented 4 years ago

Based on my reading of this thread, the Netlify badges will always show the wrong status. The GitHub Actions deploys are effectively manual deploys, but the badge shows the most recent deploy within Netlify CI, which was a failed one from before I turned off the automated builds.

jayqi commented 4 years ago

Since you're adding badges, we probably also want these:

codecov PyPI

[![codecov](https://codecov.io/gh/drivendataorg/nbautoexport/branch/master/graph/badge.svg)](https://codecov.io/gh/drivendataorg/nbautoexport)
[![PyPI](https://img.shields.io/pypi/v/nbautoexport.svg)](https://pypi.org/project/nbautoexport/)
pjbull commented 4 years ago

updated:

image
pjbull commented 4 years ago

I think the labels are redundant with the badges' text, and the empty header row looks kind of weird. It's not a position I hold strongly though—otherwise looks fine.

Agreed—it was more helpful when the docs were just a Netlify badge. Will update.

pjbull commented 4 years ago
image