ci: switch API docs to modern GH Pages action #2194
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
Gelbpunkt
approved these changes
Apr 15, 2023
itohatweb
approved these changes
Apr 15, 2023
|
I want to form consensus whether we should continue using GH Pages before merging this, see last paragraph of #2195 |
vilgotf
force-pushed
the
vilgotf/actions/api-pages
branch
from
36f9e03
to
b964054
Compare
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.
Switch the GH Pages API documentation workflow from deploying from a commit to deploying from an artifact.
Twilight currently has an extremely large
gh-pagesbranch with all snapshots of our rustdoc rendered documentation for all crates as commits. Due to the nature of how Git stores commits, this ballons the branch's size (>200 MB!) and subsequently the whole repository's size. GitHub has since last year offered publishing to Pages from an uploaded artifact as an alternative to publishing from a branch which avoids storing the contents in Git.Additionally, this renames the API documentation environment from "github-pages" to "api-documentation" which should make it more discoverable to new users.