Build and deploy dev/master documentation using GitHub Actions #4852
Conversation
This reverts commit fb82799.
|
Argh the GH action keeps failing with "Error loading key "(stdin)": invalid format". I've been trying to add the private key in the sciki-image/scikit-image secrets with and without the "begin" and "end" lines, with a new line... Is this the same error which you were having @jvkersch or another one (in which case we would undoubtedly be making progress :-))? |
|
Lo and behold, we've tested the github action with @jvkersch (with commit d172b74 which used this branch instead of master to see if the deploy worked), and it works (you can see in the online dev doc that the mitosis tutorial by @mkcor is online now)! For future reference, the authentication problems were due to the fact so that you need a specific formatting of RSA key which did not correspond to the default of Note that this PR is using a branch pushed to the scikit-image repo, which we don't do usually, so we'll have to make sure to delete that branch. @jvkersch could you please check that my last commit (switching back to master for the branch) is ok? And then @skimage/core is think this one is ready! |
|
@emmanuelle Looks good! One suggestion, if you're up for it, is to rename the |
good idea :-). Done! |
alexdesiqueira
added
the
🤖 type: Infrastructure
|
@skimage/core anything else I should do before merging this one? |
|
@scikit-image/core anything else I should do before merging this one? [former ping by @emmanuelle didn't work) |
| - name: Install Python | ||
| uses: actions/setup-python@v1 | ||
| with: | ||
| python-version: 3.7 |
There was a problem hiding this comment.
Just a question, what happens if python 3.7 is not shipped in ubuntu-lastest (which will be true a day or another)?
There was a problem hiding this comment.
I just want to know which indicator we are supposed to monitor...
There was a problem hiding this comment.
the build fails :-). And then we change the config. But it would stop early enough not to push a wrong version of the doc, if this is your concern.
.github/workflows/build-docs.yml
Outdated
| eval "$(ssh-agent -s)" | ||
| ssh-add - <<< "${DEPLOY_KEY}" | ||
| git config --global user.email "travis@travis-ci.com" | ||
| git config --global user.name "Travis Bot" |
There was a problem hiding this comment.
Shouldn't be attributed to GH-action instead? (Or am I lost?)
.github/workflows/build-docs.yml
Outdated
| python -m pip install -r requirements/docs.txt | ||
| - name: Install package | ||
| run: | | ||
| python setup.py install |
There was a problem hiding this comment.
Could we use python -m pip install . here? That will future-proof us for when we switch to pyproject.toml etc.
|
@emmanuelle this is so cool! Have you explored whether there is a way to make the docs visible on each PR, though? |
Please see #4881 for this. |
|
@sciunto @jni I made the requested changes, then I temporarily checked the action by having it run on this branch (it works, as you can see from https://github.com/scikit-image/docs/tree/gh-pages), and then I switched back to master in the last commit. I hope the PR is ready now! Don't worry about the CircleCI failure, the config file is in #4881 |
jni
changed the title
Closes #4805.
Follow-up of #4843 but with a branch in the scikit-image repo so that we can test the workflow.