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

Deploy the dev version of docs to GitHub Pages #53

Merged
merged 5 commits into from
Nov 30, 2020

Conversation

yutannihilation
Copy link
Contributor

Since docs.rs serves only the published version, providing dev docs on GitHub Pages is useful. This is not what every Rust crate does, but many packages does e.g. diesel and servo. You can view the example here: https://yutannihilation.github.io/extendr/extendr_api/

Some things I'm not sure are:

with:
toolchain: stable
- name: Install dependencies
run: sudo apt-get install r-base-dev llvm-3.9-dev libclang-3.9-dev
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need the packages llvm-3.9-dev and libclang-3.9-dev? On ubuntu-20.04, I found I don't need them, and don't need to set LIBCLANG_PATH either: https://github.com/clauswilke/helloextendr/blob/main/.github/workflows/R-CMD-check.yaml

(Note that ubuntu-latest is currently 18.04 but will soon switch to 20.04: actions/runner-images#1816.)

I think it's better to write action scripts that don't rely on specific versions of llvm/libclang, in particular if they're quite old.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, and when ubuntu-latest switches over to 20.04, the script will break because llvm version 3.9 doesn't exist for 20.04.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I just copied these lines from from the existing YAML and didn't think about the details. Let's remove them.

@yutannihilation
Copy link
Contributor Author

Confirmed the test passes without installing additional system libraries and LIBCLANG_PATH.

https://github.com/yutannihilation/extendr/runs/1471710150

@yutannihilation
Copy link
Contributor Author

Ah, since the action on this repo is already setup in the era of 18.04, maybe I need to set ubuntu-20.04 explicitly at least once?

@clauswilke
Copy link
Member

Thanks!

@clauswilke clauswilke merged commit 5c4ff6e into extendr:master Nov 30, 2020
@yutannihilation yutannihilation deleted the ci/deploy-dev-docs branch November 30, 2020 05:17
@clauswilke
Copy link
Member

Now that I have merged this I see that the link to the development documentation in the README is a bit ugly. Maybe removed it from between the badges and just write it somewhere in the main body of the text, in a sentence: "The documentation for the latest development version is available here: ..."

@yutannihilation
Copy link
Contributor Author

Ah, true. Sounds good to me. I'll prepare a pull request.

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.

None yet

2 participants