From 99eb3c42ea65f193d36956f32e9dd3a75db80529 Mon Sep 17 00:00:00 2001 From: Marc Wouts Date: Sun, 3 Jul 2022 10:45:39 +0200 Subject: [PATCH] Version 1.14.0 (#973) --- docs/CHANGELOG.md | 19 ++++++++++--------- docs/using-pre-commit.md | 11 ++++++++--- jupytext/version.py | 2 +- 3 files changed, 19 insertions(+), 13 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 306eebad4..c4a1f82ab 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,21 +1,22 @@ Jupytext ChangeLog ================== -1.13.9 (2022-07-??) +1.14.0 (2022-07-03) ------------------- **Changed** -- Hidden configuration files like `.jupytext.toml` or `.jupytext.py` are now ignored by Jupytext's contents manager when `allow_hidden=False` (that option was introduced in `jupyter_server==2.0.0a1`) ([#964](https://github.com/mwouts/jupytext/issues/964)). - The Jupytext configuration file has a new option `cm_config_log_level` that defaults to `info_if_changed`. With that value, the contents manager will log a line regarding the configuration file used only when the -config file is not the same as the one previously used ([#959](https://github.com/mwouts/jupytext/issues/959)) - -**Changed** -- `jupytext --set-formats ipynb,py test.py` will not override `test.ipynb` if the file exists already ([#969](https://github.com/mwouts/jupytext/issues/969)). - -**Changed** -- `jupytext --set-formats ipynb,py test.py` will not override `test.ipynb` if the file exists already ([#969](https://github.com/mwouts/jupytext/issues/969)). +config file is not the same as the one previously used ([#959](https://github.com/mwouts/jupytext/issues/959)) - +many thanks to R.C. Thomas for suggesting this and thoughtfully testing the patch. +- Hidden configuration files like `.jupytext.toml` or `.jupytext.py` are now ignored by Jupytext's contents manager +when `allow_hidden=False` (that option was introduced in `jupyter_server==2.0.0a1`) ([#964](https://github.com/mwouts/jupytext/issues/964)). +- We have changed `jupytext --set-formats` to make it more similar to `jupytext --sync`. Now `--set-formats` will not +override existing paired files anymore ([#969](https://github.com/mwouts/jupytext/issues/969)). +**Added** +- We have added a test `test_pre_commit_hook_sync_with_no_config` that documents how to use the pre-commit hook without +a configuration file (#967) 1.13.8 (2022-04-04) ------------------- diff --git a/docs/using-pre-commit.md b/docs/using-pre-commit.md index 0ed6b0df1..cf65163a1 100644 --- a/docs/using-pre-commit.md +++ b/docs/using-pre-commit.md @@ -5,7 +5,7 @@ Jupytext works well with the [pre-commit](https://pre-commit.com/) framework. Yo ```yaml repos: - repo: https://github.com/mwouts/jupytext - rev: v1.13.7 # CURRENT_TAG/COMMIT_HASH + rev: v1.14.0 # CURRENT_TAG/COMMIT_HASH hooks: - id: jupytext args: [--sync] @@ -16,7 +16,7 @@ You can provide almost all command line arguments to Jupytext in pre-commit, for ```yaml repos: - repo: https://github.com/mwouts/jupytext - rev: v1.13.7 # CURRENT_TAG/COMMIT_HASH + rev: v1.14.0 # CURRENT_TAG/COMMIT_HASH hooks: - id: jupytext args: [--from, ipynb, --to, "py:percent"] @@ -27,7 +27,7 @@ If you are combining Jupytext with other pre-commit hooks, you must ensure that ```yaml repos: - repo: https://github.com/mwouts/jupytext - rev: v1.13.7 # CURRENT_TAG/COMMIT_HASH + rev: v1.14.0 # CURRENT_TAG/COMMIT_HASH hooks: - id: jupytext args: [--sync, --pipe, black] @@ -40,3 +40,8 @@ repos: - id: black language_version: python3 ``` + +Tested examples of how to use the pre-commit hook are available in +our [tests](https://github.com/mwouts/jupytext/tree/main/tests) - +see for instance +[test_pre_commit_1_sync_with_config.py](https://github.com/mwouts/jupytext/blob/main/tests/test_pre_commit_1_sync_with_config.py). diff --git a/jupytext/version.py b/jupytext/version.py index 91f66e0f6..6a1c068b1 100644 --- a/jupytext/version.py +++ b/jupytext/version.py @@ -1,3 +1,3 @@ """Jupytext's version number""" -__version__ = "1.13.9-dev" +__version__ = "1.14.0"