doc: changelog + version bump

Author: mgxd

CHANGELOG.md

@@ -4,20 +4,29 @@ All notable changes to this project will be documented (for humans) in this file
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [UNRELEASED] - 2018-??-??
-TODO Summary
-### Added
+## [0.5.1] - 2018-06-29
+Bugfix release
 
+### Added
+- Video tutorial / updated slides
+- Helper to set metadata restrictions correctly
+- Usage is now shown when run without arguments
+- New fields to Seqinfo
+  - series_uid
+- Reproin heuristic support for xnat
 ### Changed
-
-### Deprecated
-
+- Dockerfile updated to use `dcm2niix v1.0.20180328`
+- Conversion table will be regenerated if heurisic has changed
+- Do not touch existing BIDS files
+  - events.tsv
+  - task JSON
 ### Fixed
-
-### Removed
-
-### Security
-
+- Python 2.7.8 and older installation
+- Support for updated packages
+  - `Datalad` 0.10
+  - `pydicom` 1.0.2
+- Later versions of `pydicom` are prioritized first
+- JSON pretty print should not remove spaces
 
 ## [0.5] - 2018-03-01
 The first release after major refactoring:

heudiconv/info.py

@@ -1,4 +1,4 @@
-__version__ = "0.5.dev1"
+__version__ = "0.5.1"
 __author__ = "HeuDiConv team and contributors"
 __url__ = "https://github.com/nipy/heudiconv"
 __packagename__ = 'heudiconv'

utils/update_changes.sh

@@ -0,0 +1,55 @@
+#!/bin/bash
+#
+# Adapted from https://github.com/nipy/nipype/blob/master/tools/update_changes.sh
+#
+# This is a script to be run before releasing a new version.
+#
+# Usage /bin/bash update_changes.sh 0.5.1
+#
+
+# Setting      # $ help set
+set -u         # Treat unset variables as an error when substituting.
+set -x         # Print command traces before executing command.
+
+CHANGES=../CHANGELOG.md
+
+
+# Add changelog documentation
+cat > newchanges <<'_EOF'
+# Changelog
+All notable changes to this project will be documented (for humans) in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+_EOF
+
+# List all merged PRs
+curl -s https://api.github.com/repos/nipy/heudiconv/pulls?state=closed+milestone=$1 | jq -r \
+'.[] | "\(.title) #\(.number) milestone:\(.milestone.title) \(.merged_at)"' | sed '/null/d' | sed '/milestone:0.5 /d' >> newchanges
+echo "" >> newchanges
+echo "" >> newchanges
+
+
+# Elaborate today's release header
+HEADER="## [$1] - $(date '+%Y-%m-%d')"
+echo $HEADER >> newchanges
+echo "TODO Summary" >> newchanges
+echo "### Added" >> newchanges
+echo "" >> newchanges
+echo "### Changed" >> newchanges
+echo "" >> newchanges
+echo "### Deprecated" >> newchanges
+echo "" >> newchanges
+echo "### Fixed" >> newchanges
+echo "" >> newchanges
+echo "### Removed" >> newchanges
+echo "" >> newchanges
+echo "### Security" >> newchanges
+echo "" >> newchanges
+
+# Append old CHANGES
+tail -n+7 $CHANGES >> newchanges
+
+# Replace old CHANGES with new file
+mv newchanges $CHANGES