Skip to content

Commit

Permalink
ci(release): remove unneeded run_notebooks.py script (#2194)
Browse files Browse the repository at this point in the history
* notebooks can be converted/executed with pytest via autotest/test_notebooks.py
* no more need to run notebooks pre-release since ipynb files are not versioned
  • Loading branch information
wpbonelli authored May 23, 2024
1 parent 7879c2f commit 71350bc
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 59 deletions.
4 changes: 0 additions & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,6 @@ jobs:
path: |
./autotest/.failed/**
- name: Run notebooks
working-directory: scripts
run: python run_notebooks.py

- name: Generate changelog
id: cliff
uses: orhun/git-cliff-action@v3
Expand Down
2 changes: 0 additions & 2 deletions docs/make_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,6 @@ As described above, making a release manually involves the following steps:

- Run `ruff check .` and `ruff format .` from the project root.

- Use `run_notebooks.py` in the `scripts` directory to rerun all notebooks in `.docs/Notebooks`.

- Generate a changelog starting from the last release with [git cliff](https://github.com/orhun/git-cliff), for instance: `git cliff --config cliff.toml --unreleased --tag=<release version number>`.

- Prepend the release changelog to the comprehensive changelog file `docs/version_changes.md`.
Expand Down
6 changes: 0 additions & 6 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,6 @@ For instance, `e689af57e7439b9005749d806248897ad550eab5_20150811_041632_uncommit

**Note**: the `process_benchmarks.py` script depends on `seaborn`, which is not included as a dependency in either `etc/environment.yml` or in any of the optional groups in `pyproject.toml`, since this is the only place it is used in this repository.

## Running notebooks

The `run_notebooks.py` script runs notebooks located in the `.docs/Notebooks` directory.

Notebooks are run using `jupytext --from_ipynb --execute <notebook path>`. Note that notebooks are under version control, and running them with this script will produce large changesets in your working tree as outputs and execution metadata are updated. See the [developer docs](../DEVELOPER.md) for instructions to configure `git` to automatically strip notebook outputs before commits.

## Updating version

The `update_version.py` script can be used to update FloPy version numbers. Running the script first updates the version in `version.txt`, then propagates the change to various other places version strings or timestamps are embedded in the repository:
Expand Down
47 changes: 0 additions & 47 deletions scripts/run_notebooks.py

This file was deleted.

0 comments on commit 71350bc

Please sign in to comment.