Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

fixed docs/website build checkout bug #12413

Merged
merged 2 commits into from
Aug 31, 2018

Conversation

aaronmarkham
Copy link
Contributor

@aaronmarkham aaronmarkham commented Aug 30, 2018

Description

Fixes a bug in the docs build pipeline where a failover case didn't checkout a different branch as expected. This caused master API docs to appear in older versions in CI. Local builds would run fine.

Added a hard error stop on the checkout step to prevent any issue like this popping up silently in CI.
Also fixed the echo statement to print exactly what should be run next.
Also removed Clojure from the v1.2.0 settings for docs generation. These should only generate in master or in 1.3.0+.

For example, in the CI logs:

+ git checkout v1.0.0
error: pathspec 'v1.0.0' did not match any file(s) known to git.
+ git branch v1.0.0 upstream/v1.0.0
Branch v1.0.0 set up to track remote branch v1.0.0 from upstream.

It checks if the branch is there already, if not it grabs it from upstream. What is missing here is that it also needed to checkout the newly created branch. If all fails then the process aborts on this step, rather than continue with master.

Comments

The consistent theme is patched in a separate PR: #12426.

@@ -14,7 +14,7 @@ r_docs = 0
scala_docs = 1

[document_sets_v1.2.0]
Copy link
Member

@szha szha Aug 31, 2018

Choose a reason for hiding this comment

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

I see two copies of document_sets_1.2.0. Is that intended?

Copy link
Member

Choose a reason for hiding this comment

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

Aaron explained offline that for each version one entry is for release branch while the other is for release tag. Currently, the pipeline is set up so that docs are built from branches.

@szha szha merged commit 5ace01c into apache:master Aug 31, 2018
aaronmarkham added a commit to aaronmarkham/incubator-mxnet that referenced this pull request Sep 11, 2018
* fixed checkout bug; fixed echo statement

* turning off clojure docs for v1.2.0
anirudh2290 pushed a commit to anirudh2290/mxnet that referenced this pull request Sep 19, 2018
* fixed checkout bug; fixed echo statement

* turning off clojure docs for v1.2.0
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants