configure circleci to auto deploy docs #115
Conversation
.circleci/config.yml
Outdated
| rm -rf _build/doctrees _build/mne_bids.github.io | ||
| git clone -b gh-pages --single-branch --no-checkout --depth 1 https://github.com/mne-tools/mne-bids _build/mne_bids.github.io | ||
| touch _build/mne_bids.github.io/.nojekyll | ||
| make html |
There was a problem hiding this comment.
Why not just use make install?
There was a problem hiding this comment.
yes good point. I think this will fail anyways because no one will be there to type in a password?
sappelhoff
force-pushed
the
deply_gh_pages_circleci
branch
from
131af51
to
58e21d3
Compare
|
okay, it is as I expected ... nobody is there to provide a password for pushing the docs to our gh-pages branch. How to solve that @jasmainak ? In the mne python link you provided they have some "pushd" command, what's that? |
| @@ -30,3 +30,11 @@ jobs: | |||
| - store_artifacts: | |||
| path: doc/_build/html/ | |||
| destination: html | |||
| - deploy: | |||
| name: github pages deployment | |||
| command: | | |||
There was a problem hiding this comment.
you should do it only for master branch with CIRCLE_BRANCH command. Then I think once I merge, it should work ... not sure but I think it should
There was a problem hiding this comment.
so reading up on this, CIRCLE_BRANCH is an environment variable pointing to the branch that is currently being built. I am not really sure what you mean by "I should use it" ... we still want to push the built docs against our gh-pages branch, don't we?
reference: https://circleci.com/docs/2.0/env-vars/
There was a problem hiding this comment.
The deploy should be done only for master branch, not for the PR branches. And the pushing to gh-pages is taken care of by make install
There was a problem hiding this comment.
Ah I see ... okay - fingers crossed then ;-)
Codecov Report
@@ Coverage Diff @@
## master #115 +/- ##
==========================================
- Coverage 93.56% 93.14% -0.42%
==========================================
Files 14 14
Lines 839 846 +7
==========================================
+ Hits 785 788 +3
- Misses 54 58 +4
Continue to review full report at Codecov.
|
|
Merged. Let's see if it works @sappelhoff |
|
@sappelhoff see my cosmit to make it work here: b6d9721 |
|
nice, two questions so that I fully understand:
|
|
I honestly don't know the answer to your first question. Maybe @larsoner knows For the second question, I copied what |
|
Actually, I think for the first, it's just a config requirement by git. So, you can track that these commits were actually made by an automatic push from Circle |
closes #113