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: build docs on CI deploy to github-pages on push to main #40

Merged
merged 8 commits into from
May 8, 2023

Conversation

tlambert03
Copy link
Member

@tlambert03 tlambert03 commented Mar 29, 2023

with #38 in, this PR enables publishing docs to a github "environment". This means that docs are served from an uploaded actions artifact (the static site) rather than a checked in branch... and it also means that manual deploys are no longer necessary.

It will build on every PR (so it will be clear if a PR breaks docs) but will only deploy on main. You can download the build artifact from CI as well if you want to take a peak

@tlambert03 tlambert03 added the documentation Improvements or additions to documentation label Mar 29, 2023
@codecov-commenter
Copy link

codecov-commenter commented Mar 29, 2023

Codecov Report

Merging #40 (348313e) into main (8f19c55) will increase coverage by 0.43%.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main      #40      +/-   ##
==========================================
+ Coverage   92.52%   92.96%   +0.43%     
==========================================
  Files          28       29       +1     
  Lines         696      725      +29     
==========================================
+ Hits          644      674      +30     
+ Misses         52       51       -1     

see 2 files with indirect coverage changes

@tlambert03 tlambert03 added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 29, 2023
@tlambert03 tlambert03 added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 29, 2023
@tlambert03 tlambert03 added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 29, 2023
@tlambert03 tlambert03 added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels May 3, 2023
@tlambert03 tlambert03 added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels May 6, 2023
@tlambert03 tlambert03 changed the title docs: enable deploy to github-pages docs: build docs on CI deploy to github-pages on push to main May 8, 2023
@tlambert03 tlambert03 merged commit 4dfcc6a into funkelab:main May 8, 2023
10 checks passed
@tlambert03 tlambert03 deleted the enable-deploy branch May 8, 2023 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants