Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate process of building docs for docs.rust-embedded.org #457

Closed
markhildreth opened this issue May 29, 2020 · 4 comments
Closed

Automate process of building docs for docs.rust-embedded.org #457

markhildreth opened this issue May 29, 2020 · 4 comments

Comments

@markhildreth
Copy link

markhildreth commented May 29, 2020

When accessing any of the three books from the docs.rust-embedded.org domain, the version of the documents received are over two months out of date, dating back to March 15th.

> date
Fri May 29 15:40:13 EDT 2020
> curl -s --head "https://rust-embedded.github.io/discovery/" | grep last-modified
last-modified: Thu, 28 May 2020 02:46:55 GMT
> curl -s --head "https://docs.rust-embedded.org/discovery/" | grep last-modified
last-modified: Sun, 15 Mar 2020 19:52:23 GMT
> curl -s --head "https://rust-embedded.github.io/book/" | grep last-modified
last-modified: Fri, 29 May 2020 17:35:25 GMT
> curl -s --head "https://docs.rust-embedded.org/book/" | grep last-modified
last-modified: Sun, 15 Mar 2020 19:52:23 GMT
> curl -s --head "https://rust-embedded.github.io/embedonomicon/" | grep last-modified
last-modified: Tue, 21 Apr 2020 17:28:25 GMT
> curl -s --head "https://docs.rust-embedded.org/embedonomicon/" | grep last-modified
last-modified: Sun, 15 Mar 2020 19:52:23 GMT

Additionally, the bookshelf is also out of date:

> curl -s --head "https://docs.rust-embedded.org" | grep last-modified
last-modified: Sun, 15 Mar 2020 19:52:23 GMT

This is because the docs.rust-embedded.org domain looks specifically to the /docs repository, which uses submodules to pull in the other book repositories. Unfortunately, there doesn't appear to be any automated system (or if there is, it is not working) to rebuild the gh-pages branch in the /docs repo enough to keep them up to date.

@adamgreig
Copy link
Member

I believe that's because those are all generated/hosted via https://github.com/rust-embedded/docs/tree/gh-pages which has each book as a submodule. Not necessarily a great system...

@markhildreth
Copy link
Author

markhildreth commented May 29, 2020

@adamgreig Ah, thanks, didn't realize they were all in that repo. Is there a system in place that should be automating this that isn't working, or is there no such automatic system in place yet?

@adamgreig
Copy link
Member

I'm not sure actually. I don't see anything that would cause a regular build to run, but such things are possible to have on Travis.

@markhildreth markhildreth changed the title Books are months out of date when accessed from docs.rust-embedded.org Automate process of building docs for docs.rust-embedded.org May 29, 2020
bors bot added a commit to rust-embedded/rust-embedded.github.io that referenced this issue Jul 4, 2020
24: Fix broken book publishing on Travis r=therealprof a=yerke

The books were not published on https://docs.rust-embedded.org/ since March 16 2020. Last successful build [here](https://travis-ci.org/github/rust-embedded/docs/builds/662804843), first broken build [here](https://travis-ci.org/github/rust-embedded/docs/builds/663216351). [Here](https://travis-ci.org/github/rust-embedded/docs/builds) you can see the long list of failures.

I took the changes from https://github.com/rust-embedded/discovery/blob/d42012eedb4216ae8b613c3fdfdb37f85f01656f/ci/install.sh .

For proof that the changes fix the issue see my fork in https://github.com/yerke/docs, which was successfully built with Travis in [here](https://travis-ci.com/github/yerke/docs/builds/174282136). You can see built artifacts at https://github.com/yerke/yerke.github.io/tree/gh-pages and https://yerke.github.io .

Closes #8, rust-embedded/wg#457, rust-embedded/discovery#253

Co-authored-by: Yerkebulan Tulibergenov <yerkebulan@gmail.com>
@yerke
Copy link

yerke commented Jul 4, 2020

Fixed with rust-embedded/rust-embedded.github.io#24

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

No branches or pull requests

3 participants