generated from sosiristseng/template-juliabook-matrix
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0107443
commit eb3d24c
Showing
1 changed file
with
18 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,43 @@ | ||
| # Template publishing Julia-kerneled Jupyter notebooks | ||
| # Template for publishing Julia Jupyter notebooks with Jupyter Book | ||
|
|
||
| Click `Use this template` button to copy this repository. | ||
|
|
||
| See also: | ||
| Related templates: | ||
|
|
||
| - [template-quarto-julia](https://github.com/sosiristseng/template-quarto-julia): using GitHub actions and dynamic matrix to execute notebooks in parallel and [quarto][] to rendeer the website. | ||
| - [template-juliabook-parallel](https://github.com/ww-jl/template-juliabook-parallel) : GNU parallel runs notebooks concurrently and [jupyter-book][] builds the website. | ||
| - [template-juliabook-matrix](https://github.com/ww-jl/template-juliabook-matrix) : Dynamic parallel matrix runs notebooks concurrently and [jupyter-book][] builds the website. | ||
| - [template-quarto-julia](https://github.com/ww-jl/template-quarto-julia) : Dynamic parallel matrix runs notebooks concurrently and [quarto][] builds the website. | ||
| - [template-mkdocs-literate](https://github.com/ww-jl/template-mkdocs-literate) : [Literate.jl][] runs notebooks concurrently and [mkdocs-material][] builds the website. | ||
| - [template-juliabook-literate](https://github.com/ww-jl/template-juliabook-literate) : [Literate.jl][] runs notebooks concurrently and [jupyter-book][] builds the website. | ||
| - [template-quarto-literate](https://github.com/ww-jl/template-quarto-literate) : [Literate.jl][] runs notebooks concurrently and [quarto][] builds the website. | ||
|
|
||
| [quarto]: https://quarto.org/ | ||
| [jupyter-book]: https://jupyterbook.org/ | ||
| [Cirrus CI]: https://cirrus-ci.org/ | ||
| [quarto]: https://quarto.org | ||
| [jupyter-book]: https://jupyterbook.org | ||
| [Literate.jl]: https://github.com/fredrikekre/Literate.jl | ||
| [mkdocs-material]: https://squidfunk.github.io/mkdocs-material | ||
|
|
||
| ## Notebook execution and publish via continuous integration (CI) | ||
|
|
||
| - Workflow file: [ci.yml](.github/workflows/ci.yml) | ||
|
|
||
| The notebooks (under the `docs` folder) are executed in parallel, and then [Jupyter book][jupyter-book] creates a beautiful website from Markdown and Jupyter notebook files. | ||
| In [ci.yml](.github/workflows/ci.yml), notebooks under the `docs` folder are executed in parallel, and then [Jupyter book][jupyter-book] creates a beautiful website from Markdown and Jupyter notebook files. | ||
|
|
||
| ## Enable GitHub pages | ||
|
|
||
| Open your repository settings => Pages => GitHub Pages => Build and deployment => Source, select `GitHub actions`. | ||
|
|
||
| ## Automatic dependency updates | ||
|
|
||
| ### Renovate bot and Kodiak Bot | ||
| ### Dependabot and Kodiak Bot | ||
|
|
||
| - See [renovate.json](renovate.json) for Renovate settings. | ||
| See [dependabot.yml](.github/dependabot.yml) configuration. | ||
|
|
||
| This repository uses [Renovate Bot](https://github.com/marketplace/renovate) to automatically update Julia packages, Python packages, and GitHub actions. | ||
| This repository also uses [Kodiak Bot](https://kodiakhq.com/docs/quickstart) to automatically merge updates. You might need to enable the Kodiak Bot APP. | ||
|
|
||
| ### Julia dependencies | ||
|
|
||
| The Github workflow [update-manifest.yml](.github/workflows/update-manifest.yml) will regularly update Julia dependencies, make a PR with the updated packages, and automatically merge (by [Kodiak bot](https://kodiakhq.com/)) the updates if the notebooks are executed without error. | ||
| The Github workflow [update-manifest.yml](.github/workflows/update-manifest.yml) will regularly update Julia dependencies, make a PR with the updated packages, and automatically merge the updates if the notebooks are executed without error. | ||
|
|
||
| See [the instructions](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs) for how to trigger CI workflows in a PR. My repo uses a custom [GitHub APP](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#authenticating-with-github-app-generated-tokens) to generate a token on the fly. | ||
|
|
||
| ## Checking HTTP links | ||
|
|
||
| GitHub actions by [linkcheck.yml](.github/workflows/linkcheck.yml) regularly check if the web links in the notebooks are valid. | ||
| [linkcheck.yml](.github/workflows/linkcheck.yml) uses GitHub actions to regularly check if the web links in the notebooks are valid. |