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

Notify failed master build + Versioned docs #75

Merged
merged 4 commits into from
Sep 5, 2021
Merged

Conversation

jayqi
Copy link
Member

@jayqi jayqi commented Sep 4, 2021

Test workflow improvements

  • Splits code quality check (linting) into a separate workflow job that runs before tests. If code quality fails, tests do not run.
  • Add a workflow job that opens an issue if any previous job fails for non-PR workflows.
  • Add workflow_dispatch trigger which enables manually triggering workflow in GitHub UI

Versioned docs using CI

  • docs-master will publish to latest version on any merges to master
  • release workflow will publish and overwrite any previous docs with same <major>.<minor> version. The new version will also be tagged with (stable) and is assigned the alias stable.

We use latest and stable to refer to master branch and current release, respectively, per Read the Docs naming convention. I've also updated the README badge to say "stable" instead of "latest".

All docs are stored on the gh-pages branch, and the workflows will push that branch to Netlify. I've manually backfilled existing releases. This won't be pushed to Netlify until the PR is merged. In the meantime, you can see https://erdantic.drivendata.org/ as an example.

PR previews continue to work as-is without integration with the other versions.

@@ -1,13 +1,11 @@
-c requirements.txt
-r requirements.txt
Copy link
Member Author

Choose a reason for hiding this comment

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

These are redundant because -e . will already include them since they are dependencies of nbautoexport.

@jayqi jayqi requested review from pjbull and ejm714 September 4, 2021 13:46
@jayqi
Copy link
Member Author

jayqi commented Sep 4, 2021

Tests failing due to #76

@codecov
Copy link

codecov bot commented Sep 5, 2021

Codecov Report

Merging #75 (4656636) into master (fa4c80c) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master     #75   +/-   ##
======================================
  Coverage    98.1%   98.1%           
======================================
  Files           8       8           
  Lines         382     382           
======================================
  Hits          375     375           
  Misses          7       7           

@github-actions
Copy link
Contributor

github-actions bot commented Sep 5, 2021

@pjbull pjbull merged commit 8d9681b into master Sep 5, 2021
@pjbull pjbull deleted the versioned-docs branch September 5, 2021 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants