ci-cd: add env variables needed to generate binder links in online doc #89
Conversation
There was a problem hiding this comment.
In order to play nicely with #75, please do not touche these steps, but instead create a new step which sets these variables in GITHUB_ENV.
If build.yml is run when pushing a tag, this is a mistake, we only want to run release.yml, so you can remove the handling of this case.
This is the case at least on my fork. The "on push" event triggers when pushing commits and tags. Perhaps we should restrict this (in another PR :) ) |
|
Build.yml is also triggered in airbus repo for tags, see: https://github.com/airbus/scikit-decide/actions?query=event%3Apush+branch%3Av0.9.2 |
nhuet
force-pushed
the
nh/add-env-variables-for-binder-links
branch
from
29ff287
to
6652e57
Compare
|
New step created as suggested by #89 (review) |
|
Thanks, but please make this new step the first one of build-docs (in both files), to make sure there will be no conflict with Generate. This step only modifies GITHUB_ENV, thus having it as a first step looks fine, even if these environment variables are only used at the end. |
| - name: Set env variables for github+binder links in doc | ||
| run: | | ||
| # binder environment repo and branch | ||
| AUTODOC_BINDER_ENV_GH_REPO_NAME="airbus/scikit-decide" |
There was a problem hiding this comment.
Why should we want to use the airbus/scikit-decide binder on a fork and not the local binder ?
There was a problem hiding this comment.
To make sure that everything works as expected when pull request is merged.
nhuet
force-pushed
the
nh/add-env-variables-for-binder-links
branch
from
6652e57
to
11dfe71
Compare
- variables for binder env "hard-coded" to point to airbus/scikit-decide:binder - variables for notebooks content defined thanks to github variables available in actions - done as first step to avoid conflicts with other PRs
nhuet
force-pushed
the
nh/add-env-variables-for-binder-links
branch
from
11dfe71
to
e94fe6b
Compare
The build.yml and release.yml are modified to define the environment variables needed by autodoc.py to generate the github and binder links for notebooks after PR #85.
The resulting doc with proper github/binder links can be checked
NB: only one notebook listed here as PR Maze notebook: educational version #65 and PR Scheduling notebook #66 have not yet been merged.