ci: Automatically publish docs for new releases #436
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## main #436 +/- ##
==========================================
+ Coverage 91.55% 91.66% +0.10%
==========================================
Files 90 90
Lines 10532 10532
Branches 1450 1450
==========================================
+ Hits 9643 9654 +11
+ Misses 886 875 -11
Partials 3 3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
godlygeek
force-pushed
the
publish_pages_automatically
branch
2 times, most recently
from
a428342
to
17957cb
Compare
We no longer have any pre-push hooks configured, so this call is no longer useful. Signed-off-by: Matt Wozniski <[email protected]>
godlygeek
force-pushed
the
publish_pages_automatically
branch
from
17957cb
to
7216edf
Compare
godlygeek
changed the title
godlygeek
force-pushed
the
publish_pages_automatically
branch
from
bb3262c
to
aa42110
Compare
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: Matt Wozniski <[email protected]>
godlygeek
force-pushed
the
publish_pages_automatically
branch
from
aa42110
to
1fead8a
Compare
|
The new job has if: github.event_name == 'release' && github.event.action == 'published'so that it only runs for new releases, but I iterated on this without that guard to confirm that it works, and the docs currently up on https://bloomberg.github.io/memray/ were published by this job. Had to prove it works somehow, and it was a perfect time to do this since we just had a release and hadn't yet updated the docs 😄 |
pablogsal
approved these changes
Aug 2, 2023
|
Wonderful! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An update of #223, rebased and PR'd from a branch instead of a fork so that it can (hopefully) request write permissions for the job that needs to publish the docs...