Merge pull request #140 from neithernut/release-prep

Preparations for the 0.3.0 release

CHANGELOG.md

@@ -1,5 +1,81 @@
 # git-dit ChangeLog
 
+## v0.3.0 (2017-08-13)
+
+### Binary
+
+Changes:
+ * "tag" now doesn't require a local head reference to be present in advance.
+ * "check-message" does not require a repository to be present any more.
+
+Added features:
+ * New git-config option "dit.remote-prios" controlling how remote references
+   are chosen for various actions.
+ * New "mirror" subcommand for mirroring remote references as local ones.
+ * New "gc" subcommand for collecting old references.
+ * New "check-refname" subcommand for extracting information from reference
+   names.
+ * The "list" subcommand now supports a small set simple filters for filtering
+   issues based on metadata.
+ * "get-issue-metadata" can now be used for querying a single piece of metadata.
+ * Example server-side update hook for a dit-only policy for repositories with
+   global unauthenticated push access.
+
+Bug-fixes:
+ * "fetch" and "push" tried fetching/pushing issues multiple times under some
+   circumstances.
+ * "list" and "get-issue-tree-init-hashes" reported issues multiple times under
+   some circumstances.
+
+### Library
+
+Changes:
+ * `RepositoryExt::issues_with_prefix()` and `RepositoryExt::issues()` now
+   return a unique set of issues.
+ * `Issue::update_head()` now takes an additional parameter controlling whether
+   an existing head reference is replaced.
+ * `Issue::messages_revwalk()` was replaced by new `Issue::messages()` function.
+ * `Issue::first_parent_revwalk()` was replaced by new
+   `Issue::first_parent_messages()` function.
+ * Function `Issue::find_local_head()` was renamed to `Issue::local_head()`.
+ * `Issue::local_refs()` now has an additional parameter controlling the type of
+   references returned.
+ * `Issue::issue_leaves()` was removed.
+ * `message::line` module was replaces by `message::block` module, including
+   associated types.
+ * `LineIteratorExt::categorized_lines()` was replaced by
+   `LineIteratorExt::line_blocks()`.
+ * `Message::categorized_body()` was replaced by `Message::body_blocks()`.
+ * `TrailerValue::append()` now operates in-place, on a mutable reference.
+
+Added features:
+ * New type `Messages` for iterating over messages.
+ * New function `Issue::terminated_messages()` for preparing a `Messages`
+   instance which terminates at the initial message.
+ * New function `Issue::messages_from()` for creating a `Messages` instance
+   returning messages from one specific commit to the initial message.
+ * New module `message::accumulation` for accumulating issue metadata.
+ * New module `message::metadata` providing specification of a small set of
+   predefined pieces of issue metadata
+ * New type `IssueRefType` representing the type of a reference (e.g. "head" or
+   "leaf").
+ * New `PairsToTrailers` iterator for assembling trailers from key-value pairs.
+ * New `Issue::remote_refs()` and `Issue::all_refs()` functions for retrieving
+   references.
+ * Implemented `PartialEq`, `Eq` and `Hash` for `Issue`.
+ * Implemented `From<Messages>` for `IssueMessagesIter`.
+ * Implemented `AsRef<String>` for `TrailerKey`
+
+Bug-fixes:
+ * Fixed lifetimes of return values of several `Issue` functions.
+
+### Documentation
+ * Building the manpage is now controlled via the `manpage` feature rather than
+   an environment variable.
+ * The subcommand descriptions are now longer set as code snippets.
+ * Various small fixes and updates.
+
+
 ## v0.2.1 (2017-07-16)
 
 Changes:

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "git-dit"
-version = "0.2.1"
+version = "0.3.0"
 description = "A CLI frontend for libgitdit - a distributed issue tracker"
 authors = ["Matthias Beyer <[email protected]>",
            "Julian Ganz <[email protected]>"]

git-dit.1.md

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

lib/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "libgitdit"
-version = "0.2.1"
+version = "0.3.0"
 description = "A library for distributed issue tracking in git"
 authors = ["Matthias Beyer <[email protected]>",
            "Julian Ganz <[email protected]>"]

src/cli.yaml

@@ -1,5 +1,5 @@
 name: git-dit
-version: 0.2.1
+version: 0.3.0
 authors:
     - Julian Ganz <[email protected]>
     - 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.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -36,7 +36,7 @@ subcommands:
 
     - check-refname:
         about: Checks whether a reference is a dit reference of a known type, by name
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -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.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -88,7 +88,7 @@ subcommands:
 
     - find-tree-init-hash:
         about: This command prints the init hash of the issue commit belongs to.
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -103,7 +103,7 @@ subcommands:
         about: >
                  Prints a log of commit tags, from the supplied issue head to
                  the initial issue message.
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -140,7 +140,7 @@ subcommands:
 
     - get-issue-tree-init-hashes:
         about: Lists all SHA1 hashes of all issues (introducing commit)
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -149,7 +149,7 @@ subcommands:
     # Porcelain subcommands
     - fetch:
         about: Fetch issues
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -179,7 +179,7 @@ subcommands:
                  Perform garbage collection:
                  delete references which are no longer required
 
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -208,7 +208,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.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -238,7 +238,7 @@ subcommands:
 
     - mirror:
         about: Clone issue references from remotes
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -287,7 +287,7 @@ subcommands:
 
     - new:
         about: Create a new bug report
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -343,7 +343,7 @@ subcommands:
         about: >
                  Push all refs associated with issues.
                  If no issue were supplied, all issues will be pushed.
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -360,7 +360,7 @@ subcommands:
 
     - reply:
         about: Reply to a specific message in an issue.
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -414,7 +414,7 @@ subcommands:
 
     - show:
         about: This uses 'git log' to print the issues.
-        version: 0.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>
@@ -480,7 +480,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.2.1
+        version: 0.3.0
         authors:
             - Matthias Beyer <[email protected]>
             - Julian Ganz <[email protected]>

src/logger.rs

@@ -1,6 +1,6 @@
 //   git-dit - the distributed issue tracker for git
-//   Copyright (C) 2016 Matthias Beyer <[email protected]>
-//   Copyright (C) 2016 Julian Ganz <[email protected]>
+//   Copyright (C) 2016, 2017 Matthias Beyer <[email protected]>
+//   Copyright (C) 2016, 2017 Julian Ganz <[email protected]>
 //
 //   This program is free software; you can redistribute it and/or modify
 //   it under the terms of the GNU General Public License version 2 as

src/main.rs

@@ -1,6 +1,6 @@
 //   git-dit - the distributed issue tracker for git
-//   Copyright (C) 2016 Matthias Beyer <[email protected]>
-//   Copyright (C) 2016 Julian Ganz <[email protected]>
+//   Copyright (C) 2016, 2017 Matthias Beyer <[email protected]>
+//   Copyright (C) 2016, 2017 Julian Ganz <[email protected]>
 //
 //   This program is free software; you can redistribute it and/or modify
 //   it under the terms of the GNU General Public License version 2 as

src/msgtree.rs

@@ -1,6 +1,6 @@
 //   git-dit - the distributed issue tracker for git
-//   Copyright (C) 2016 Matthias Beyer <[email protected]>
-//   Copyright (C) 2016 Julian Ganz <[email protected]>
+//   Copyright (C) 2016, 2017 Matthias Beyer <[email protected]>
+//   Copyright (C) 2016, 2017 Julian Ganz <[email protected]>
 //
 //   This program is free software; you can redistribute it and/or modify
 //   it under the terms of the GNU General Public License version 2 as

src/write.rs

@@ -1,6 +1,6 @@
 //   git-dit - the distributed issue tracker for git
-//   Copyright (C) 2016 Matthias Beyer <[email protected]>
-//   Copyright (C) 2016 Julian Ganz <[email protected]>
+//   Copyright (C) 2016, 2017 Matthias Beyer <[email protected]>
+//   Copyright (C) 2016, 2017 Julian Ganz <[email protected]>
 //
 //   This program is free software; you can redistribute it and/or modify
 //   it under the terms of the GNU General Public License version 2 as