CI: Documentation test gen, links, images, etc. #449
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
markmandel
added
kind/feature
XAMPPRocky
approved these changes
Nov 30, 2021
Introduces both building the documentation sites with `mdbook` and `cargo doc` as well as placing them in the same directory structure as they exist in on GitHub pages. Utilising `htmltest` to test the links, images, scripts etc in the `mdbook` pages (there are lots of invalid anchors in the rustdoc, so not testing the links for now - but we could later). To use locally: `make test-docs` will run the tests for you. Extra notes: * Had to use a fork of `htmltest`, as awaiting the merging of a critical bugfix. * Split up each of the test targets in `cloudbuild.yaml`. This requires a bit more work when writing new test targets in the Makefile, but will be easier to determine why things go wrong in CI. * Broke up the Dockerfile into sections, to make it faster for local rebuilding. Fix googleforgames#367
markmandel
force-pushed
the
ci/test-site
branch
from
9d9b9b2 to
da7365e
Compare
|
Build Succeeded 🥳 Build Id: 4530f2ef-90a7-482e-a860-73cd462e9faf To build this version: |
iffyio
approved these changes
Dec 1, 2021
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.
What type of PR is this?
/kind feature
What this PR does / Why we need it:
Introduces both building the documentation sites with
mdbookandcargo docas well as placing them in the same directory structure as they exist in on GitHub pages.Utilising
htmltestto test the links, images, scripts etc in themdbookpages (there are lots of invalid anchors in the rustdoc, so not testing the links for now - but we could later).To use locally:
make test-docswill run the tests for you.Which issue(s) this PR fixes:
Closes #367
Special notes for your reviewer:
htmltest, as awaiting the merging of a critical bugfix.cloudbuild.yaml. This requires a bit more work when writing new test targets in the Makefile, but will be easier to determine why things go wrong in CI.