This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/master by this push:
new 4b10cfd Added dev docs on release note "contributions" which will
start with 3.4.0 CTR
4b10cfd is described below
commit 4b10cfda1f85aefe3017ec7fc25791d409719329
Author: Stephen Mallette <[email protected]>
AuthorDate: Tue Dec 18 14:53:55 2018 -0500
Added dev docs on release note "contributions" which will start with 3.4.0
CTR
---
.mailmap | 7 +++++++
docs/src/dev/developer/release.asciidoc | 8 ++++++++
pom.xml | 1 +
3 files changed, 16 insertions(+)
diff --git a/.mailmap b/.mailmap
new file mode 100644
index 0000000..cd19e2a
--- /dev/null
+++ b/.mailmap
@@ -0,0 +1,7 @@
+# --------------------------------------------------------------------------
+# maps log commit email addresses to user names so that they properly report
+# for release notes with: git shortlog -sn
+# --------------------------------------------------------------------------
+Stephen Mallette <[email protected]>
+Florian Hockmann <[email protected]>
+Jason Plurad <[email protected]>
\ No newline at end of file
diff --git a/docs/src/dev/developer/release.asciidoc
b/docs/src/dev/developer/release.asciidoc
index fcb6cb2..0450135 100644
--- a/docs/src/dev/developer/release.asciidoc
+++ b/docs/src/dev/developer/release.asciidoc
@@ -190,6 +190,14 @@ issue title and `D` is the label field: `="* "&A2&"
"&B2&(IF(D2="breaking"," \*(
current release was under development as this new release will have those
changes included within it. Please see
3.2.1 for an example.
.. Format "breaking" changes to be clearly marked (use JIRA and the "breaking"
label to identify those - already accounted for if using the suggested formula
above)
+.. Run `git shortlog -sn previous-xx.yy.zz..current-xx.yy.zz` and paste the
output into the "Contributors" section of
+the CHANGELOG.
+... The `previous-xx.yy.zz` should be the oldest line of code currently under
release.
+... Review the output to be sure that the command aggregated the names
properly. If there are duplicates it may be
+necessary to run the command with `-e` to see the emails that are being used
and then creating an entry in `.mailmap`
+to consolidate the counts.
+... Include other notes about contributors who distinguished themselves in
some way on a particular release if
+necessary (e.g. the release manager responsible for a particular release).
. Update "upgrade documentation":
.. Update the release date.
.. Update the link to `CHANGELOG.asciidoc` - this link may already be correct
but will not exist until the repository is tagged.
diff --git a/pom.xml b/pom.xml
index bd37141..8eae6af 100644
--- a/pom.xml
+++ b/pom.xml
@@ -355,6 +355,7 @@ limitations under the License.
<configuration>
<excludeSubProjects>false</excludeSubProjects>
<excludes>
+ <exclude>.mailmap</exclude>
<exclude>.travis.yml</exclude>
<exclude>.travis.*.sh</exclude>
<exclude>.dockerignore</exclude>
