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

ci: Automatically publish docs for new releases #129

Merged
merged 1 commit into from
Aug 2, 2023
Merged

ci: Automatically publish docs for new releases #129

merged 1 commit into from
Aug 2, 2023

Conversation

pablogsal
Copy link
Member

On each new release, automatically build our docs and publish them to GitHub Pages. The docs are also built by our linting workflow, but we don't attempt to reuse that build here, because the linting build runs towncrier with a phony version number in order to exercise the news fragments in the news/ directory, and we don't want that fake version in the changelog we publish.

@codecov-commenter
Copy link

codecov-commenter commented Aug 2, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (55d2f73) 90.00% compared to head (dc9d058) 90.00%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #129   +/-   ##
=======================================
  Coverage   90.00%   90.00%           
=======================================
  Files          48       48           
  Lines        5575     5575           
  Branches      873      873           
=======================================
  Hits         5018     5018           
  Misses        557      557           
Flag Coverage Δ
cpp 75.16% <ø> (ø)
python_and_cython 99.94% <ø> (ø)

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

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

@pablogsal pablogsal enabled auto-merge (rebase) August 2, 2023 12:15
On each new release, automatically build our docs and publish them to
GitHub Pages. The docs are also built by our linting workflow, but we
don't attempt to reuse that build here, because the linting build runs
`towncrier` with a phony version number in order to exercise the news
fragments in the news/ directory, and we don't want that fake version in
the changelog we publish.

Signed-off-by: Pablo Galindo <pablogsal@gmail.com>
Copy link
Contributor

@godlygeek godlygeek left a comment

Choose a reason for hiding this comment

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

I uncommented the if: github.event_name == 'release' && github.event.action == 'published' so that this will only run on new releases, and force-pushed. Otherwise, LGTM.

@pablogsal pablogsal merged commit db5d353 into main Aug 2, 2023
48 checks passed
@pablogsal pablogsal deleted the docs branch August 2, 2023 18:49
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.

3 participants