feat: Publishes mdbook to Github Pages #4343
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
maddeleine
force-pushed
the
mdbook_publish
branch
from
b750dcf
to
f0d7d4f
Compare
dougch
approved these changes
Jan 4, 2024
There was a problem hiding this comment.
I sort of arbitrarily chose to do this site update when a PR is merged, rather than each time a PR is updated. I just don't think we need that much fidelity for documentation changes, but I'm open to other opinions.
This is reasonable and how were doing the others.
camshaft
reviewed
Jan 4, 2024
camshaft
approved these changes
Jan 6, 2024
dougch
reviewed
Jan 8, 2024
| aws-region: us-west-1 | ||
|
|
||
| - name: Upload to S3 | ||
| if: github.event_name == 'push' || github.repository == github.event.pull_request.head.repo.full_name |
There was a problem hiding this comment.
right- not publishing to s3 for external forks.
dougch
approved these changes
Jan 8, 2024
dougch
pushed a commit
to dougch/s2n-tls
that referenced
this pull request
Jan 17, 2024
This was referenced Mar 14, 2024
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.
Resolved issues:
N/A
Description of changes:
Publishes our usage guide mdbook to our github pages branch. I basically just copied s2n-quic's mdbook publish workflow, so you can find a preview of the book if you click on the github action: "book / url"
Callouts
This workflow will not run if you are opening a PR from a fork of s2n-tls. I'd rather keep s2n-tls and s2n-quic in sync than fix this problem, but it should be noted that PRs from forks won't have the preview.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.