Merge pull request #158 from neithernut/release-prep

Preparations for the 0.4.0 release

CHANGELOG.md

@@ -1,5 +1,67 @@
 # git-dit ChangeLog
 
+## v0.4.0 (2017-09-15)
+
+### Binary
+
+Changes:
+ * The message formatting for the "show" subcommand was improved.
+ * In filter-specs for the "list" subcommand, a '=' is used for separating key
+   and value when filtering for an exact value, rather than a ':'.
+
+Added features:
+ * The "create-message", "new", "reply" and "tag" now accept the "--author" and
+   "--date" options. Analogue to the options of "git commit" with the same name,
+   the new options alter the author and authoring date of the resulting message.
+ * New "reporter-name" and "reporter-email" filter keys for issue filtering
+   using the "list" subcommand. As the name suggests, the keys may be used for
+   filtering issues based on the reporter's name or email.
+ * Filter specs for the "list" subcommand can now be used for filtering by
+   substring or presence of a piece of issue metadata.
+ * Filter specs for the "list" subcommand can now be inverted.
+
+Bug-fixes:
+ * Git-dit did not handle pager and editor flags correctly. For example,
+   configuring `less -R` as the pager (contrary to `less`) would cause git-dit
+   search for a binary named "less -R", resulting in an error.
+
+### Library
+
+Changes:
+ * `LineIteratorExt::stripped()` now returns an iterator which also strips
+   trailing blank lines.
+ * `Issue::new()` now returns a `Result`.
+ * Multi-line trailers parsed by the `Blocks` iterator are represented as String
+   `TrailerValue` with newlines separating the individual lines from the input.
+ * `trailer` was promoted to a top-level module.
+ * `message::accumulation` was moved to `trailer`
+ * `message::metadata` was moved to `trailer` and renamed to `spec`.
+ * `MetadataSpecification` was renames to `TrailerSpec`.
+ * `PairsToTrailers` and `DitTrailers` iterator was moved to new
+   `trailers::iter` module.
+ * `Trailers` iterator was moved to `message::block` module.
+ * `DitTrailers` is now a generic iterator adapter on top of an iterator over
+   `Trailer`s.
+
+Added features:
+ * New `TrailingBlankTrimmer` for removing trailing blank lines from sequences
+   of lines.
+ * New `StrippingIter` for stripping messages of comments and unnecessary white
+   space.
+ * New `TrailerFilter` type for filtering based on trailers.
+ * New `ValueMatcher` type for matching `TrailerValue`s.
+ * New `MessagesExt` convenience trait for iterators over messages. The trait
+   provides accumulation functionality.
+ * New `MultiAccumulator` trait for map-based accumulation of multiple trailers.
+ * Implemented `Default` for `TrailerValue`.
+ * Implemented `Clone` for `ValueAccumulator`.
+ * Implemented `From<Blocks>` for `Trailers`
+
+### Documentation
+ * Add documentation of internals as a `README.md` to the sources of both the
+   binary and the library.
+
+
 ## v0.3.0 (2017-08-13)
 
 ### Binary

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "git-dit"
-version = "0.3.0"
+version = "0.4.0"
 description = "A CLI frontend for libgitdit - a distributed issue tracker"
 authors = ["Matthias Beyer <mail@beyermatthias.de>",
            "Julian Ganz <neither@nut.email>"]

README.md

@@ -28,7 +28,9 @@ The following crates are used:
 * error-chain 0.10
 * git2 0.6
 * is-match 0.1
+* lazy_static 0.2
 * log 0.3
+* regex 0.2
 
 Additionally, for building the man page, `pandoc` is required.
 

git-dit.1.md

@@ -1,6 +1,6 @@
 % GIT-DIT(1) User Manuals
 % Matthias Beyer, Julian Ganz
-% August 13, 2017
+% September 15, 2017
 
 # NAME
 

lib/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "libgitdit"
-version = "0.3.0"
+version = "0.4.0"
 description = "A library for distributed issue tracking in git"
 authors = ["Matthias Beyer <mail@beyermatthias.de>",
            "Julian Ganz <neither@nut.email>"]

src/cli.yaml

@@ -1,5 +1,5 @@
 name: git-dit
-version: 0.3.0
+version: 0.4.0
 authors:
     - Julian Ganz <neither@nut.email>
     - Matthias Beyer <mail@beyermatthias>
@@ -23,7 +23,7 @@ subcommands:
     # Plumbing subcommands
     - check-message:
         about: This command checks the message in file for validity
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -36,7 +36,7 @@ subcommands:
 
     - check-refname:
         about: Checks whether a reference is a dit reference of a known type, by name
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -70,7 +70,7 @@ subcommands:
                  Supplying an issue hash but no parent is considered an error.
                  Returns (prints) the hash of the new commit.
 
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -98,7 +98,7 @@ subcommands:
 
     - find-tree-init-hash:
         about: This command prints the init hash of the issue commit belongs to.
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -113,7 +113,7 @@ subcommands:
         about: >
                  Prints a log of commit tags, from the supplied issue head to
                  the initial issue message.
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -150,7 +150,7 @@ subcommands:
 
     - get-issue-tree-init-hashes:
         about: Lists all SHA1 hashes of all issues (introducing commit)
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -159,7 +159,7 @@ subcommands:
     # Porcelain subcommands
     - fetch:
         about: Fetch issues
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -189,7 +189,7 @@ subcommands:
                  Perform garbage collection:
                  delete references which are no longer required
 
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -218,7 +218,7 @@ subcommands:
                      <hash> (<date when the issue was added, human readable>) <header line>
                  More functionality may come and the output format may change.
 
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -248,7 +248,7 @@ subcommands:
 
     - mirror:
         about: Clone issue references from remotes
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -297,7 +297,7 @@ subcommands:
 
     - new:
         about: Create a new bug report
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -363,7 +363,7 @@ subcommands:
         about: >
                  Push all refs associated with issues.
                  If no issue were supplied, all issues will be pushed.
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -380,7 +380,7 @@ subcommands:
 
     - reply:
         about: Reply to a specific message in an issue.
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -444,7 +444,7 @@ subcommands:
 
     - show:
         about: This uses 'git log' to print the issues.
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>
@@ -510,7 +510,7 @@ subcommands:
                  <value> part can be in quotes to permit spaces.
                  Multiple -s are permitted, later specified values will override
                  former. Alter tags of an issue.
-        version: 0.3.0
+        version: 0.4.0
         authors:
             - Matthias Beyer <mail@beyermatthias.de>
             - Julian Ganz <neither@nut.email>