diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index bd26f51..a893b3f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,7 +8,7 @@ ci: repos: - repo: https://github.com/astral-sh/ruff-pre-commit - rev: "v0.12.2" + rev: "v0.14.9" hooks: - id: ruff types_or: [python, pyi, jupyter] @@ -17,7 +17,7 @@ repos: types_or: [python, pyi, jupyter] - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v5.0.0 + rev: v6.0.0 hooks: - id: trailing-whitespace exclude: '.*\.fits$' @@ -31,7 +31,7 @@ repos: args: ["--maxkb=10000"] - repo: https://github.com/kynan/nbstripout - rev: 0.8.1 + rev: 0.8.2 hooks: - id: nbstripout args: ["--extra-keys=metadata.kernelspec metadata.language_info.version metadata.toc"] diff --git a/README.md b/README.md index ccac2b9..5d5e756 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This README describes how the _astropy-learn_ organization is designed, how it f - _tutorial--*_: each tutorial (or book) is its own repo, emulating the _tutorial--template_ file structure. ### How the repos interact -Within a _tutorial--*_ repo, when the [build.yml file](https://github.com/astropy-learn/tutorial--template/blob/main/.github/workflows/build.yml) is triggered, _action--pre-process_ is called to populate the Jupyter Book config script for that notebook. _action--pre-process_ runs the [associated Python script](https://github.com/astropy-learn/astropy-tutorials/blob/main/scripts/pre-process.py) kept in the _astropy-tutorials_ repo. +Within a _tutorial--*_ repo, when the [build.yml file](https://github.com/astropy-learn/tutorial--template/blob/main/.github/workflows/build.yml) is triggered, _action--pre-process_ is called to populate the Jupyter Book config script for that notebook. _action--pre-process_ runs the [associated Python script](https://github.com/astropy-learn/astropy-tutorials/blob/main/scripts/pre-process.py) kept in the _astropy-tutorials_ repo. Then, the _build.yml_ workflow calls _action--execute-convert_ (which runs the [associated Python script](https://github.com/astropy-learn/astropy-tutorials/blob/main/scripts/execute-convert.py) kept in the _astropy-tutorials_ repo) to build the _.ipynb_ notebook into _.html_. This step determines if a single tutorial page or a Jupyter Book 'book' (collection of notebooks) should be built, as checked in the Python script. The Jupyter Book HTML build outputs are pushed to the _converted_ branch in the tutorial repo.