path: root/doc/src/09020-changelog.md

# Changelog {#sec:changelog}

This section contains the changelog.

We try to include a changelog line in each pull request, to make sure the
changelog is up to date when releasing a new version of the codebase.
Make sure to append the new change to the list, do not prepend it.

The "Major" section of each section includes huge changes in functionality and
interfaces (but not necessarily user-facing ones), whereas the "Minor" section
contains only small stuff.
Some things, like typo fixes, version string updates and such are not stated in
the changelog (though updating of dependencies is).
Please note that we do not have a "Breaking changes" section as we are in
Version 0.y.z and thus we can break the API like we want and need to.

## Next

This section contains the changelog from the last release to the next release.

* Major changes
    * `imag-timetrack list --from/--to` now have `kairos` support - that means
      that complex `--from/--to` arguments (like `yesterday` or `today-2weeks`)
      are now possible
    * `libimagerror` got a major refactoring and uses `ChainedError` from
      `error-chain` for logging errors now.
    * `libimagentryref` and all libraries using it were rewritten.
      `libimagentryref` was rewritten to make its API simpler and yet more powerful.
      Also because it used to put entries under a "ref" collection in the store,
      but users of the library really should be be able to put entries under
      custom collections.
    * `imag store ids` was replaced by `imag ids`.
    * `libimagentrylist` was removed. Its functionality was inconvenient to use
      and ugly to implement. Its API was cumbersome.
      Listing of entries shall be implemented without it.
    * `libimagcontact` is now able to fetch all contacts from the store.
    * `libimagcontact` takes the hash from the vcard object (UID) now.
    * `imag-contact` got a `find` command, which matches in fullname, email and
      address and either shows or lists the found contacts
    * `imag-contact list` and `imag-contact find` is now able to print the
      output as JSON.
    * `imag-edit` can now read store ids from stdin, so
      `imag ids | fzf | imag edit -I` is now a thing.
    * `imag ids` does not print the path of the store. Can be turned on using
      commandline flag.
    * `imag-habit today --done` and `imag-habit status --done` was added for
      showing habits which are already done.
* Minor changes
    * A license-checker was included into the CI setup, which checks whether all
      ".rs"-files have the license header at the top of the file
    * `imag-link` does not allow linking the entry to itself
    * `imag` sorts available commands alphabetically now
    * `imag` has a new subcommand `help` for consistency with other tools
    * `imag-grep` does not print grep statistics when only files with matches
      are listed
    * The `"Ok"` output which was printed on success was removed from all
      commands
    * `imag-log show` was aliased to `imag-log list`
    * `imag-* --version` shows `git describe` output if binary was compiled in
      "debug" mode.
    * `imag-diary` supports "daily" diaries now.
    * `imag-contact` joins multiple emails with "," now
    * `imag-tag` commandline was rewritten for positional arguments.
    * `libimagrt` automatically takes "rt.editor" into account when building
      editor object
    * `libimagentryref` got a utility function for making an entry a ref.
    * `libimaghabit` got `Habit::instance_exists_for_date()`
* Bugfixes
    * imag does not panic anymore when piping and breaking that pipe, for
      example like with `imag store ids | head -n 1`.
      For that, `libimagerror` got a `Result` extension which can translate
      errors into exit codes and one for unwrapping or exiting with the
      `Err(i32)` from the result.
    * `libimagdiary` did not add the header markers on diary entries.
    * `imag-diary` used the default diary rather than the CLI setting. Now it
      rather uses the CLI setting and only if that is not present, it uses the
      default.
    * `libimagerror` printed errors with `write!()` rather than `writeln!()`
      when tracing.
    * A parsing error in `libimagstore`, which caused the parsing of entries
      with a line "---" in the content part to fail, was fixed.
    * The patch explained by the point above introduced a bug which caused
      entries to be read as a single line, which was fixed as well.
    * `imag-diary create --timed` did not work as expected
    * `libimagstore` got another fix with the file parsing, as the
      `std::str::Lines` iterator takes empty lines as no lines.
    * `libimagentryedit` fixed to inherit stdin and stderr to child process for
      editor command.
    * `libimagrt` produced the editor command without taking arguments into
      account.
    * `libimagentryref` got a fix where the buffer for the hash calculation was
      not allocated properly.
    * `libimagstore::store::Store::create` overwrote existing entries.
    * `libimaghabit::habit::HabitTemplate` did not link new instances.


## 0.6.3

Bugfix release for fixing:

* `libimagstore` got another fix with the file parsing, as the
  `std::str::Lines` iterator takes empty lines as no lines.


## 0.6.2

Bugfix release for fixing:

* `imag-diary` did not recognize the "-d DIARY" setting.
* A parsing error in `libimagstore`, which caused the parsing of entries
  with a line "---" in the content part to fail, was fixed.
* The bugfix above introduced another bug which caused entries to be rewritten
  in one line when accessing them. This was fixed.
* `imag-diary` did not properly set "minute" and "second" when creating "hourly"
  or "minutely" entries.
* Version numbers for all crates as well as in the docs were updated to "0.6.2".


## 0.6.1

Bugfix release for fixing two severe bugs in `imag-init`:

* `imag-init` created the git directory inside the imag directory. Fixed by
  defaulting to `{imag directory}/.git`.
* `imag-init` was buggy as it did not include the `imagrc.toml` file in the
  release, thus building it from crates.io failed


## 0.6.0

* Major changes
    * The config infrastructure of `libimagstore` was removed, as it was unused.
    * The iterators of `libimagstore` were improved and are now abstract over
      all iterator types. For example, all iterators over `StoreId` can now be
      transformed into a `StoreGetIterator`.
    * `imag-log` was introduced
    * `imag-init` was introduced
    * `libimagdiary` supports second-granularity now.
    * `libimagstore::store::Store::retrieve_copy` was renamed to
      `libimagstore::store::Store::get_copy`, which describes the semantics of
      the function way better.
    * `libimagentryutil` was introduced, a library for helpers for
      `libimagstore::store::Entry` handling and writing extension-writing.
    * `imag-edit` was introduced
    * `imag-diary` got second-granularity support in the CLI.
* Minor changes
    * Internals were refactored from `match`ing all the things into function
      chaining
    * The `toml-query` dependency was updated to 0.5.0
    * `imag-timetrack list` lists with a table now
    * `imag-timetrack stop` now stops all running tags if none are specified
    * The `toml-query` dependency was updated to 0.6.0
    * `ResultExt::map_err_trace_exit()` was removed in favour of
      `ResultExt::map_err_trace_exit_unwrap()`.
    * `imag-view` shows content by default now. Use `-C` to hide the content.
    * `kairos` dependency was updated to 0.1.0
* Bugfixes
    * `libimagbookmark` contained a type which wrapped a `FileLockEntry` from
      `libimagstore`. This was considered a bug and was fixed.
    * We depended on a crate which was licensed as GPLv2, which would yield imag
      GPL as well. The dependency was removed.
    * The `imag` crate prints the "command filed" error message to stderr now.
      It also prefixes the subcommand with `imag-<command>` for better user
      experience.
    * `libimagnotes` did not set the note name in the header of the note.
    * `imag-mv` automatically fixes links when moving an entry in the store.
    * `imag-log` listed non-log entries (normal diary entries) before, was
      changed to only list `log` entries.

## 0.5.0

* Major changes
    * `imag-counter` and `libimagcounter` was removed.
    * `imag-mv` was introduced
    * `imag-view` uses positional args now
    * `imag-view` uses the configuration file now to find the command to call
      for viewing the entry. This way one can view the entry in an editor or the
      browser or on the toaster.
    * The logger is now able to handle multiple destinations (file and "-" for
      stderr)
    * `imag-store` can dump all storeids now
    * `imag-annotate` was introduced
    * `imag-diagnostics` was added
    * The runtime does not read the config file for editor settings anymore.
      Specifying an editor either via CLI or via the `$EDITOR` environment
      variable still possible.
    * `imag-contact` was added (with basic contact support so far).
    * `imag-habit` was introduced
    * `imag-link` commandline was redesigned to be easier but with the same
      features.

* Minor changes
    * `libimagentryannotation` got a rewrite, is not based on `libimagnotes`
      anymore. This is minor because `libimagentryanntation` is not yet used by
      any other crate.
    * imag now reads the `IMAG_RTP` environment variable before trying to access
      `$HOME/.imag` for its runtimepath.
    * `libimagnotification` was introduced, though not yet integrated into the
      CLI tools

* Bugfixes
    * `Store::entries()` does not yield StoreIds which point to directories
      anymore, only StoreIds pointing to files.

* Stats
    * 227 commits
    * 51 merge-commits / 176 non-merge commits
    * 2 contributors
    * 186 files changed
    * 6707 insertions(+) / 3255 deletions(-)

## 0.4.0

* Major changes
    * The `libimagstore::toml_ext` module was removed. The `toml_query` crate
      should be used as a replacement. Its interface only differs in few places
      from the old `libimagstore::toml_ext` interface.
    * The codebase was moved to a more tree-ish approach, where several
      subdirectories were introduced for different types of crates
    * The documentation got a major overhaul and was partly rewritten
    * The logger is now configurable via the config file.
    * The error handling of the whole codebase is based on the `error_chain`
      now. `libimagerror` only contains convenience functionality, no
      error-generating macros or such things anymore.
    * `imag-diary` can now use a configuration in the imagrc.toml file where for
      each diary there is a config whether entries should be created minutely or
      hourly (or daily, which is when specifying nothing).
* New
    * `libimagentrygps` was introduced
    * `imag-gps` was introduced
    * `imag-grep` was introduced
    * The `imag` command now passes all arguments properly to the called
      subcommand
* Fixed bugs
    * The config loading in `libimagrt`
    [was fixed](http://git.imag-pim.org/imag/commit/?id=9193d50f96bce099665d2eb716bcaa29a8d9b8ff).
    * `libimagentrylink` used `imag` as the location for putting links in
      entries. This is not allowed because this namespace is reserved for the
      store itself. This bug was fixed, links are now located in the `links`
      namespace in the header of an entry.
    * `Store::delete()` did only check the store-internal cache whether an entry
      exists, but not the filesystem. This was fixed.
* Minor changes
    * If building from a `nix-shell`, the mozilla rust overlay is expected to be
      present
    * Unused imports in the codebase were removed
    * Compiler Warnings were fixed
    * We specify inter-dependencies via path and variable now, so one can build
      the 0.3.0 release from the checkout of the codebase.
    * The `imag` binary was refactored and rewritten, the `crossbeam`
      dependency was removed.
    * The `Makefile` was removed as `cargo` is powerful enough to fit our needs
    * `libimagstore::storeid::StoreId::is_in_collection()` was added
    * The `libimagentrylink` is now rudimentarily tested
    * We compile with rustc 1.17, 1.18, .., nightly
    * The `imag-store` binary now uses positional arguments in its CLI
    * The "toml-query" dependency was updated to 0.3.1
    * `imag-timetrack track` is now able to parse "now", date-only start/stop
      dates and date-time start/stop times.
    * `libimagnotes` does not longer wrap store types but extend them.
    * `imag-notes` uses positional arguments now.
    * `libimagentrylist` does not export a CLI helper module anymore.

* Stats
    * ~325 commits
    * 82 merge-commits / 243 non-merge commits
    * 2 contributors
    * 447 files changed
    * 9749 insertions(+) / 7806 deletions(-) (Surely because of the
      reorganization of the entire codebase)

## 0.3.0

<small>
    Note: As this file was written _after_ the 0.3.0 release, we simply list the
    merges here instead of explaining what changed.
</small>

* Merges
    * [d14c972](http://git.imag-pim.org/imag/commit/?id=d14c9720e7ff4982ec5c13e011c8c27f3e92ea10)
      matthiasbeyer/release-commits-import
    * [f6a1c7d](http://git.imag-pim.org/imag/commit/?id=f6a1c7d56f1f559214a97d65dd1870e9f9906d71)
      matthiasbeyer/make-check
    * [0404b24](http://git.imag-pim.org/imag/commit/?id=0404b24333f7f41cb6821fd11003260ec45799af)
      matthiasbeyer/update-deps
    * [85e95d1](http://git.imag-pim.org/imag/commit/?id=85e95d142cc40f18df0da6a08e07ce6873394516)
      matthiasbeyer/readme-rewrite
    * [fa64c2d](http://git.imag-pim.org/imag/commit/?id=fa64c2d27dc4b9afbfa7d077ed7821e7688e0339)
      matthiasbeyer/libimagstore/store-id-cmp-without-base
    * [0a04081](http://git.imag-pim.org/imag/commit/?id=0a040815993803defe79749786adbd01f40b79b2)
      matthiasbeyer/cargo-rustc-codegen-units
    * [a4db420](http://git.imag-pim.org/imag/commit/?id=a4db420fdb43186258a7dc08ffb597a82d11f32a)
      matthiasbeyer/cargo-workspaces
    * [8bacdb4](http://git.imag-pim.org/imag/commit/?id=8bacdb49b9d2826bcf6ab5773ba09c46913ba5a9)
      matthiasbeyer/libimagref/remove-unused
    * [13c57aa](http://git.imag-pim.org/imag/commit/?id=13c57aa0cea1071accb00248f28537bf4288af13)
      matthiasbeyer/imag-link/reduce-unwraps
    * [e70fdc6](http://git.imag-pim.org/imag/commit/?id=e70fdc63c8f566039cf3f1afa910fa1a47430415)
      matthiasbeyer/libimagentrytag/remove-impl-tagable-on-fle
    * [1db063f](http://git.imag-pim.org/imag/commit/?id=1db063f3343ccb8d7a2ea2f1c3acf8eb24d39162)
      Stebalien/master
    * [a6a7e43](http://git.imag-pim.org/imag/commit/?id=a6a7e43b39979a276243807ac7569ef04e13f9db)
      mario-kr/add_shell-completion
    * [002c50a](http://git.imag-pim.org/imag/commit/?id=002c50a39e2a4e9426b0f8cc4bc7cc0d7ed8d599)
      matthiasbeyer/clap-completion
    * [b210b0e](http://git.imag-pim.org/imag/commit/?id=b210b0ec3edfc6269baedc2791d780b169975877)
      matthiasbeyer/libimagstore/entry-eq
    * [fe1c577](http://git.imag-pim.org/imag/commit/?id=fe1c5779634d22913db78b44717559b5a4e7c53f)
      matthiasbeyer/libimagstore/extract-toml-functionality
    * [4ca560a](http://git.imag-pim.org/imag/commit/?id=4ca560af7ff82d4dc9fabc5ef9abc579f288d3d7)
      matthiasbeyer/travis-use-old-rustc
    * [0310c21](http://git.imag-pim.org/imag/commit/?id=0310c2176f342fb42a55b5b3f025843bb8cf6a49)
      rnestler/libimagdiary/refactor_from_store_id
    * [9714028](http://git.imag-pim.org/imag/commit/?id=9714028cf3c6c3a1e6b32704030c52d2d82954c1)
      matthiasbeyer/clap-recommend-versions
    * [2003efd](http://git.imag-pim.org/imag/commit/?id=2003efd70646e121865cf12c4183c37388ad48f3)
      matthiasbeyer/imag-mail/init
    * [7c7aad9](http://git.imag-pim.org/imag/commit/?id=7c7aad9ea4578ac45e17895f73cf55d9a966b767)
      matthiasbeyer/libimagentrylink/fix-docu-typo
    * [0dd8498](http://git.imag-pim.org/imag/commit/?id=0dd849863fbca535525c136a02e47a3f8c394854)
      matthiasbeyer/update-deps
    * [9375c71](http://git.imag-pim.org/imag/commit/?id=9375c71292e8ec57bb6c970992f9f3aa33d54786)
      matthiasbeyer/makefile-check-outdated
    * [23a80ee](http://git.imag-pim.org/imag/commit/?id=23a80ee47f279fa1f5cd70ffab81e82629322dc8)
      matthiasbeyer/imag-link/external-link-remove-arg
    * [4a821d7](http://git.imag-pim.org/imag/commit/?id=4a821d7b196a4d478cdf51520c4c2939aaa06a81)
      matthiasbeyer/rust-beta-remove-top-level-cargotoml
    * [0cf5640](http://git.imag-pim.org/imag/commit/?id=0cf564091ece3c12ab83b1c5bb8555b1149c3d21)
      mario-kr/add_workspace-support
    * [c96e129](http://git.imag-pim.org/imag/commit/?id=c96e129b40c34a0fd99df3a9bf32285337885a4a)
      matthiasbeyer/libimagrt/logger-pub
    * [2c4946a](http://git.imag-pim.org/imag/commit/?id=2c4946a82c8eca33b619aeffc8a264566278658f)
      matthiasbeyer/remove-for-focus-shift
    * [9d7a26b](http://git.imag-pim.org/imag/commit/?id=9d7a26ba3ac42aa89670d032c97e5500ebde0828)
      matthiasbeyer/libimagrt/dbg-fileline-opt
    * [6dbecbd](http://git.imag-pim.org/imag/commit/?id=6dbecbd397de15727773857121282356cd98986d)
      matthiasbeyer/libimagrt/config-types-pub
    * [03a90c9](http://git.imag-pim.org/imag/commit/?id=03a90c9bf9ae4558842b30d0bce2968879e6efa8)
      matthiasbeyer/cleanup-bash-compl-gen
    * [6f564b5](http://git.imag-pim.org/imag/commit/?id=6f564b5223f9ec811f21081db31e16eb77d6d634)
      matthiasbeyer/love-to-defaultnix
    * [ce36b38](http://git.imag-pim.org/imag/commit/?id=ce36b38aa9ef25f8a0cc8f21860102b9950566a2)
      matthiasbeyer/fix-imag-bin-build
    * [cd684b0](http://git.imag-pim.org/imag/commit/?id=cd684b04ab696e7456d6ba6e51ebabcf96cb7f0f)
      matthiasbeyer/travis-opt
    * [636bfbb](http://git.imag-pim.org/imag/commit/?id=636bfbb768f23c92d581ab660fcaa88927c859b1)
      matthiasbeyer/imag-link/list-internal-only
    * [1e3193e](http://git.imag-pim.org/imag/commit/?id=1e3193ebb2028478aa26efd1b69697cddf00914f)
      matthiasbeyer/imag-ruby
    * [71e1a4c](http://git.imag-pim.org/imag/commit/?id=71e1a4cd61ad7748a252c77bb9c9eaa4ab01934e)
      matthiasbeyer/libimagerror/fix-warnings
    * [b03d1b5](http://git.imag-pim.org/imag/commit/?id=b03d1b562da4649d56411d21671ec5fc659ff65a)
      matthiasbeyer/libimagstore/fix-warnings
    * [0a417aa](http://git.imag-pim.org/imag/commit/?id=0a417aa3c6b599f067284ed1628d7e3fc5e9a44e)
      matthiasbeyer/libimagruby/fix-warnings
    * [55ea7f8](http://git.imag-pim.org/imag/commit/?id=55ea7f8228481a4859b1c2d34f9347b7cd35ee8e)
      matthiasbeyer/readme-updates
    * [ddc49de](http://git.imag-pim.org/imag/commit/?id=ddc49de0c315f10d7dd085aed3dbd3b88d78343b)
      matthiasbeyer/libimagruby/fix-macro
    * [df0fa43](http://git.imag-pim.org/imag/commit/?id=df0fa438c578bcf51ada250aea7eda7aed5ded89)
      matthiasbeyer/imag-tag/remove-warning
    * [3c7edcf](http://git.imag-pim.org/imag/commit/?id=3c7edcfb501d1f88df4a5e1d47c8bc1ac441cb20)
      matthiasbeyer/update-regex
    * [15b3567](http://git.imag-pim.org/imag/commit/?id=15b356773f7536dabc8346f79d9887016188e4b1)
      matthiasbeyer/workspace-fix-missing-doc
    * [6585677](http://git.imag-pim.org/imag/commit/?id=6585677d3147d338b271fb6477ea324694fa5454)
      matthiasbeyer/libimagentryfilter/remove-unused-import
    * [2ca89b7](http://git.imag-pim.org/imag/commit/?id=2ca89b73291a33d8209890b762343460ccc68604)
      matthiasbeyer/workspace-fix
    * [63ffbf6](http://git.imag-pim.org/i