Fix genDoc script. Make sure main website is generated on snapshot. #8131
Conversation
This file contains hidden or 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
When building a snapshot of the documentation, we must also build the main website. Essentially this means generating the same website twice, one time in the root directory, the second time in the $version/ subdirectory of the root. This is so because the contents of the github website will be completely overwritten by the result of the `genDocs` command. Hence, when the command is run with `-doc-snapshot` flag, we must not only capture the doc snapshot but also generate the valid website.
dottybot
reviewed
Jan 29, 2020
There was a problem hiding this comment.
Hello, and thank you for opening this PR! 🎉
All contributors have signed the CLA, thank you! ❤️
Commit Messages
We want to keep history, but for that to actually be useful we have
some rules on how to format our commit messages (relevant xkcd).
Please stick to these guidelines for commit messages:
- Separate subject from body with a blank line
- When fixing an issue, start your commit message with
Fix #<ISSUE-NBR>:- Limit the subject line to 72 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line ("Add" instead of "Added")
- Wrap the body at 80 characters
- Use the body to explain what and why vs. how
adapted from https://chris.beams.io/posts/git-commit
Have an awesome day! ☀️
nicolasstucki
approved these changes
Jan 30, 2020
|
@anatoliykmetyuk it still failed. I created https://github.com/lampepfl/dotty-website/tree/gh-pages/0.RC-dummy and restarted the CI test to see if that helps. |
|
@anatoliykmetyuk it looks like we are adding an extra |
This was referenced Jan 30, 2020
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.
When building a snapshot of the documentation, we must
also build the main website. Essentially this means generating
the same website twice, one time in the root directory,
the second time in the $version/ subdirectory of the root.
This is so because the contents of the github website will be
completely overwritten by the result of the
genDocscommand.Hence, when the command is run with
-doc-snapshotflag,we must not only capture the doc snapshot but also generate the valid
website.