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

fix doc deployment #133

Merged
merged 1 commit into from
Oct 22, 2023
Merged

fix doc deployment #133

merged 1 commit into from
Oct 22, 2023

Conversation

orbeckst
Copy link
Member

  • fix doc CI fails #132
  • updated doc workflow with more recent code from mdaencore's docs.yaml:
    • modern parameters for conda-incubator/setup-miniconda@v2
    • use Python 3.11 for building docs
    • use ci/environment.yaml
  • now also build on PR (as a test), only deploy on merge
  • canonical package name of sphinx-sitemap in environment (prefer dash to underscore)
  • updated requirements.txt (at least pro-forma, not sure if we use it)

- fix #132
- updated doc workflow with more recent code from mdaencore's docs.yaml:
  - modern parameters for conda-incubator/setup-miniconda@v2
  - use Python 3.11 for building docs
  - use ci/environment.yaml
- now also build on PR (as a test), only deploy on merge
- canonical package name of sphinx-sitemap in environment (prefer dash to
  underscore)
- updated requirements.txt (at least pro-forma, not sure if we use it)
@codecov
Copy link

codecov bot commented Oct 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (21032fb) 87.55% compared to head (16d86d0) 87.55%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #133   +/-   ##
=======================================
  Coverage   87.55%   87.55%           
=======================================
  Files           5        5           
  Lines         747      747           
  Branches      127      127           
=======================================
  Hits          654      654           
  Misses         56       56           
  Partials       37       37           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@lilyminium lilyminium left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the fix @orbeckst!

Searching through the repo didn't turn up any matches for requirements.txt being used anywhere, best to keep it up-to-date as you're doing here unless we remove it though.

- name: deploy docs
uses: peaceiris/actions-gh-pages@v3
if: github.event_name != 'pull_request'
Copy link
Member

Choose a reason for hiding this comment

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

:O good catch here!

@lilyminium lilyminium merged commit aee81c2 into master Oct 22, 2023
10 checks passed
@lilyminium lilyminium deleted the fix-doc-deployment branch October 22, 2023 03:09
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.

doc CI fails
2 participants