You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/workflows/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# GitHub Actions
2
2
3
-
There is a single github action file with multiple jobs, which builds both the conda package and documentation, and optionally publishes the documentation: [build](https://github.com/TomographicImaging/CIL/blob/master/.github/workflows/build.yml)
3
+
There is a single github action file with multiple jobs, which builds both the conda package and documentation, and optionally publishes the documentation: [build](./build.yml)
4
4
5
5
The jobs are:
6
6
@@ -29,7 +29,7 @@ When opening or modifying a pull request to `master`, a single variant is built
29
29
> The action does not publish to conda, instead this is done by jenkins. We will eventually move from jenkins to conda-forge instead.
30
30
> When pushing to `master` or creating an [annotated tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging), *all* variants are built and tested.
31
31
32
-
It looks for conda-build dependencies in the channels listed [here](https://github.com/TomographicImaging/CIL/blob/master/.github/workflows/build.yml#L118). If you add any new dependencies, the appropriate channels need to be added to this line.
32
+
It looks for conda-build dependencies in the channels listed [here](./build.yml#L118). If you add any new dependencies, the appropriate channels need to be added to this line.
33
33
34
34
> [!TIP]
35
35
> The `conda` job builds the `*.tar.bz2` package and uploads it as an artifact called `cil-package`.
@@ -38,11 +38,11 @@ It looks for conda-build dependencies in the channels listed [here](https://gith
38
38
39
39
## docs
40
40
41
-
This github action builds and optionally publishes the documentation located in [docs/source](https://github.com/TomographicImaging/CIL/tree/master/docs/source). To do this it uses a forked version of the [build-sphinx-action](https://github.com/lauramurgatroyd/build-sphinx-action).
41
+
This github action builds and optionally publishes the documentation located in [docs/source](../../docs/source).
42
42
43
-
The [docs](https://github.com/TomographicImaging/CIL/blob/master/.github/workflows/build.yml#L124) job:
43
+
The [docs](./build.yml#L124) job:
44
44
45
-
- creates a `miniconda` environment from [requirements-test.yml](https://github.com/TomographicImaging/CIL/blob/master/scripts/requirements-test.yml) and [docs_environment.yml](https://github.com/TomographicImaging/CIL/blob/master/docs/docs_environment.yml)
45
+
- creates a `miniconda` environment from [requirements-test.yml](../../scripts/requirements-test.yml) and [docs_environment.yml](../../docs/docs_environment.yml)
46
46
-`cmake` builds & installs CIL into the `miniconda` environment
47
47
- builds the HTML documentation with `sphinx`
48
48
- uploads a `DocumentationHTML` artifact (which can be downloaded to view locally for debugging)
0 commit comments