diff --git a/CHANGELOG.md b/CHANGELOG.md index c86cf268..9ec50c1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,42 +1,21 @@ # Changelog -## [v3.3-beta2](https://pypi.org/project/jrnl/v3.3-beta2/) (2022-10-22) +## [v3.3](https://pypi.org/project/jrnl/v3.3/) (2022-10-29) -[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v3.3-beta...v3.3-beta2) +[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v3.3-beta2...v3.3) **Implemented enhancements:** -- Add machine-readable format for --list [\#1445](https://github.com/jrnl-org/jrnl/issues/1445) - -**Fixed bugs:** - -- Fix bug for new `--list --format` options when no default journal is specified [\#1621](https://github.com/jrnl-org/jrnl/pull/1621) ([wren](https://github.com/wren)) - -**Documentation:** - -- Documentation of "display\_format" incorrectly states that it can be used to change date display format [\#1617](https://github.com/jrnl-org/jrnl/issues/1617) -- Remove wrong option in configuration file reference [\#1618](https://github.com/jrnl-org/jrnl/pull/1618) ([DSiekmeier](https://github.com/DSiekmeier)) - -## [v3.3-beta](https://pypi.org/project/jrnl/v3.3-beta/) (2022-10-08) - -[Full Changelog](https://github.com/jrnl-org/jrnl/compare/v3.2...v3.3-beta) - -**Implemented enhancements:** - -- Add dependency security checks in CI [\#1488](https://github.com/jrnl-org/jrnl/issues/1488) -- Add machine-readable format for --list [\#1445](https://github.com/jrnl-org/jrnl/issues/1445) - Change default config to use journal key [\#1594](https://github.com/jrnl-org/jrnl/pull/1594) ([micahellison](https://github.com/micahellison)) - Add machine readable --list output [\#1592](https://github.com/jrnl-org/jrnl/pull/1592) ([apainintheneck](https://github.com/apainintheneck)) **Fixed bugs:** -- Bug Report - Sometimes jrnl crashes and truncates journal file [\#1599](https://github.com/jrnl-org/jrnl/issues/1599) -- Zero-length file created when attempting to export YAML to a directory that does not exist [\#1593](https://github.com/jrnl-org/jrnl/issues/1593) +- Fix bug for new `--list --format` options when no default journal is specified [\#1621](https://github.com/jrnl-org/jrnl/pull/1621) ([wren](https://github.com/wren)) - Don't create empty file when attempting a YAML export to a non-existing folder [\#1600](https://github.com/jrnl-org/jrnl/pull/1600) ([outa](https://github.com/outa)) **Build:** -- Replace Dependabot [\#1560](https://github.com/jrnl-org/jrnl/issues/1560) - Update `.gitignore` [\#1604](https://github.com/jrnl-org/jrnl/pull/1604) ([wren](https://github.com/wren)) - Fix Docs Accessibility Testing [\#1588](https://github.com/jrnl-org/jrnl/pull/1588) ([wren](https://github.com/wren)) - Update to use renamed flag for `brew bump-formula-pr` [\#1587](https://github.com/jrnl-org/jrnl/pull/1587) ([wren](https://github.com/wren)) @@ -48,8 +27,9 @@ **Documentation:** -- \[Documentation\] Edit on Github link broken [\#1601](https://github.com/jrnl-org/jrnl/issues/1601) -- Update `--format yaml` example in docs [\#1525](https://github.com/jrnl-org/jrnl/issues/1525) +- Add documentation about how the editor must be a blocking process [\#1456](https://github.com/jrnl-org/jrnl/issues/1456) +- Document that editors must be blocking processes [\#1624](https://github.com/jrnl-org/jrnl/pull/1624) ([micahellison](https://github.com/micahellison)) +- Remove wrong option in configuration file reference [\#1618](https://github.com/jrnl-org/jrnl/pull/1618) ([DSiekmeier](https://github.com/DSiekmeier)) - Update YAML export description in docs [\#1591](https://github.com/jrnl-org/jrnl/pull/1591) ([apainintheneck](https://github.com/apainintheneck)) - Update dependency jinja2 to v3.1.2 [\#1579](https://github.com/jrnl-org/jrnl/pull/1579) ([renovate[bot]](https://github.com/apps/renovate)) - Update dependency typed.js to v2.0.12 [\#1578](https://github.com/jrnl-org/jrnl/pull/1578) ([renovate[bot]](https://github.com/apps/renovate)) @@ -115,6 +95,8 @@ [Full Changelog](https://github.com/jrnl-org/jrnl/compare/v3.0-beta2...v3.0) +🚨 **BREAKING CHANGES** 🚨 + **Implemented enhancements:** - Show name of journal when creating a password/encrypting [\#1478](https://github.com/jrnl-org/jrnl/pull/1478) ([jonakeys](https://github.com/jonakeys)) diff --git a/docs/external-editors.md b/docs/external-editors.md index be321bab..4e8f70b7 100644 --- a/docs/external-editors.md +++ b/docs/external-editors.md @@ -8,11 +8,13 @@ License: https://www.gnu.org/licenses/gpl-3.0.html Configure your preferred external editor by updating the `editor` option in your [configuration file](./reference-config-file.md#editor) +If your editor is not in your operating system's `PATH` environment variable, +then you will have to enter in the full path of your editor. + !!! note To save and log any entry edits, save and close the file. -If your editor is not in your operating system's `PATH` environment variable, -then you will have to enter in the full path of your editor. +All editors must be [blocking processes](https://en.wikipedia.org/wiki/Blocking_(computing)) to work with jrnl. Some editors, such as [micro](https://micro-editor.github.io/), are blocking by default, though others can be made to block with additional arguments, such as many of those documented below. If jrnl opens your editor but finishes running immediately, then your editor is not a blocking process, and you may be able to correct that with one of the suggestions below. ## Sublime Text diff --git a/docs/overview.md b/docs/overview.md index df09d273..5ab25c1a 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -39,7 +39,7 @@ read them or edit them. `jrnl` plays nicely with your favorite text editor. You may prefer to write journal entries in an editor. Or you may want to make changes that require a more comprehensive application. `jrnl` can filter specific entries and pass them -to the external editor of your choice. +to the [external editor](./external-editors.md) of your choice. ## Encryption diff --git a/docs/reference-config-file.md b/docs/reference-config-file.md index 3a057cdb..1c58a3a2 100644 --- a/docs/reference-config-file.md +++ b/docs/reference-config-file.md @@ -47,10 +47,11 @@ key will be used instead. If set, executes this command to launch an external editor for writing and editing your entries. The path to a temporary file is passed after it, and `jrnl` processes the file once -the editor is closed. +the editor returns control to `jrnl`. -Some editors require special options to work properly. See -[External Editors](external-editors.md) for details. +Some editors require special options to work properly, since they must be +blocking processes to work with `jrnl`. See [External Editors](external-editors.md) +for details. ### encrypt If `true`, encrypts your journal using AES. Do not change this diff --git a/jrnl/__version__.py b/jrnl/__version__.py index 09700b5f..3d0bbe9b 100644 --- a/jrnl/__version__.py +++ b/jrnl/__version__.py @@ -1 +1 @@ -__version__ = "v3.3-beta2" +__version__ = "v3.3" diff --git a/pyproject.toml b/pyproject.toml index b8dbcb08..d1d40a5f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "jrnl" -version = "v3.3-beta2" +version = "v3.3" description = "Collect your thoughts and notes without leaving the command line." authors = [ "jrnl contributors ",