diff options
| author | Eric Huss <eric@huss.org> | 2020-11-13 08:19:52 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-13 08:19:52 -0800 |
| commit | 59f2a9bf4ed62f7ad37ff8a14887886ca16ef576 (patch) | |
| tree | 6b6bfdc4f77622d8c98fac739ad22dfdacff278b | |
| parent | 552e3378cf22e9011b32cd1c3a7740f13b7eb14a (diff) | |
| parent | 75d0f1efd48e01114e63260defe1f7e14bd937b8 (diff) | |
Merge pull request #1373 from avisionh/docs/ci-guide-update
Docs: CI guide update
| -rw-r--r-- | guide/src/continuous-integration.md | 37 | ||||
| -rw-r--r-- | guide/src/misc/contributors.md | 3 |
2 files changed, 39 insertions, 1 deletions
diff --git a/guide/src/continuous-integration.md b/guide/src/continuous-integration.md index 50a92af0..e9dacc6e 100644 --- a/guide/src/continuous-integration.md +++ b/guide/src/continuous-integration.md @@ -39,6 +39,9 @@ permissions (or "repo" for private repositories). Go to your repository's Travis CI settings page and add an environment variable named `GITHUB_TOKEN` that is marked secure and *not* shown in the logs. +Whilst still in your repository's settings page, navigate to Options and change the +Source on GitHub pages to `gh-pages`. + Then, append this snippet to your `.travis.yml` and update the path to the `book` directory: @@ -55,6 +58,40 @@ deploy: That's it! +Note: Travis has a new [dplv2](https://blog.travis-ci.com/2019-08-27-deployment-tooling-dpl-v2-preview-release) configuration that is currently in beta. To use this new format, update your `.travis.yml` file to: + +```yaml +language: rust +os: linux +dist: xenial + +cache: + - cargo + +rust: + - stable + +before_script: + - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update) + - (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.3" mdbook) + - cargo install-update -a + +script: + - mdbook build path/to/mybook && mdbook test path/to/mybook + +deploy: + provider: pages + strategy: git + edge: true + cleanup: false + github-token: $GITHUB_TOKEN + local-dir: path/to/mybook/book + keep-history: false + on: + branch: master + target_branch: gh-pages +``` + ### Deploying to GitHub Pages manually If your CI doesn't support GitHub pages, or you're deploying somewhere else diff --git a/guide/src/misc/contributors.md b/guide/src/misc/contributors.md index 8d1a30ff..0be8f55c 100644 --- a/guide/src/misc/contributors.md +++ b/guide/src/misc/contributors.md @@ -16,5 +16,6 @@ shout-out to them! - [Phaiax](https://github.com/Phaiax) - Matt Ickstadt ([mattico](https://github.com/mattico)) - Weihang Lo ([@weihanglo](https://github.com/weihanglo)) +- Avision Ho ([@avisionh](https://github.com/avisionh)) -If you feel you're missing from this list, feel free to add yourself in a PR.
\ No newline at end of file +If you feel you're missing from this list, feel free to add yourself in a PR. |