Skip to content

TST, DOC: store circleci doc artifacts #12349

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

Merged
merged 1 commit into from
Nov 10, 2018

Conversation

tylerjereddy
Copy link
Contributor

Activate storage of circleci doc artifacts so that devdocs that are built by circleci already can be viewed directly from a link in circleci to inspect changes.

This is done by SciPy already and tends to help reviewers quickly look at doc changes without having to compile locally. Although I think the links that are generated are initially only visible to core devs, I'm pretty sure they can share the links when critiquing doc changes in PRs, which may help communication on changes there.

This does cost us 4 minutes of extra time for the uploads, so 7->11 minutes total for circleci -- should still be shorter than i.e., full test suite runs in other CI jobs though. We could explore breaking out to separate circleci stuff in parallel if we really wanted, but maybe overkill for now.

Could think about activating the NEP doc artifact storage as well.

I noticed both sets of artifacts were commented out, which is perhaps my lingering concern here -- maybe someone did think about doing this and consciously decided not to?

Sample artifact from a test run on my fork here: https://2-116427166-gh.circle-artifacts.com/0/home/circleci/repo/doc/build/html/index.html

@charris
Copy link
Member

charris commented Nov 9, 2018

I noticed both sets of artifacts were commented out, which is perhaps my lingering concern here

Who commented them out?

@mattip
Copy link
Member

mattip commented Nov 9, 2018

They were commented out from the initial commit of the file by @stefanv, out of caution

@charris charris merged commit d50484a into numpy:master Nov 10, 2018
@charris
Copy link
Member

charris commented Nov 10, 2018

Let's put this in, it isn't a critical change and can be fixed up later if it needs improvement, for instance, more convenient access. Thanks Tyler.

@tylerjereddy tylerjereddy deleted the circleci_doc_artifacts branch November 10, 2018 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants