Skip to content

Deploy docs for latest master.#2665

Merged
kinnison merged 1 commit into
rust-lang:masterfrom
ehuss:devel-deploy
Feb 17, 2021
Merged

Deploy docs for latest master.#2665
kinnison merged 1 commit into
rust-lang:masterfrom
ehuss:devel-deploy

Conversation

@ehuss

@ehuss ehuss commented Feb 16, 2021

Copy link
Copy Markdown
Contributor

This changes it so that every merge to master and stable will trigger the docs to be rebuilt. The stable docs appear at https://rust-lang.github.io/rustup/ and the latest master appears at https://rust-lang.github.io/rustup/devel/.

@kinnison

Copy link
Copy Markdown
Contributor

As I'm reading this it looks like changes to master will also rebuild stable's with the new mdbook. I think that's probably fine.

Is there any way mdbook can fail, and if so, is it worth having a doc workflow which generates an artifact someone could download from a PR to check that their docs built okay?

I'll merge this though because it looks good. ❤️

@kinnison kinnison merged commit 823a5e8 into rust-lang:master Feb 17, 2021
@ehuss

ehuss commented Feb 17, 2021

Copy link
Copy Markdown
Contributor Author

Is there any way mdbook can fail, and if so, is it worth having a doc workflow which generates an artifact someone could download from a PR to check that their docs built okay?

Generally, there are very few ways mdbook can fail in normal operation. Usually mistakes in book.toml or a malformed SUMMARY.md.

I'm not sure I understand what you mean about generating an artifact. You can run mdbook build locally and generally get the same results. AFAIK, the only way to store artifacts with just GitHub's setup is via GitHub Releases, which we wouldn't want to use, or committing them to a git repository. Otherwise, you have to setup your own server to host it.

@kinnison

Copy link
Copy Markdown
Contributor

We can serve artifacts from pipelines (we actually provide rustup-init from the pipelines) but I think it's not that useful if mdbook is easy to run locally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants