Maintain and update release-notes with things that have changed

[TheSnoozer]

Github offers the really nice feature to maintain and somewhat publish release notes within it's release page:
https://github.com/ktoso/maven-git-commit-id-plugin/releases

I think this is something that can be used to tell about important features...just tested this with the latest available and it should be updated for older releases as well

TODO:

• review changes for version 2.2.3 and check for anything game-breaking and update release-notes
• create release-notes for version 2.2.2
• create release-notes for version 2.2.1
• create release-notes for version 2.2.0
• create release-notes for version 2.1.15
• create release-notes for version 2.1.14
• create release-notes for version 2.1.13
• create release-notes for version 2.1.12
• think about if it would be worth creating release-notes for older releases

Note:
this will not create any tags or modify anything in the git-repository - basically this is just giving a git tag that has been generated by the maven-release-plugin a meaning full thing attached to it :-)

[ktoso]

Awesome release notes, thanks a ton for doing that :-)

[TheSnoozer]

Not a problem :-)
Its somewhat really interesting to look into the history of this plugin and find out what went wrong and went good.

Feel free to edit / adjust them if you find any typos or want anything in particular added.
For the next releases I would just use the latest as a copy-paste template :-)

[ktoso]

Yeah sounds good - so far all good! :)

[TheSnoozer]

Just for reference:
When creating the 2.1.13 release-notes I accidentally put in v.2.1.13 for the tag (note the extra dot). I could remove it since it didn't made any sense...

$ git tag -d v.2.1.13
Deleted tag 'v.2.1.13' (was f0450de)

This commit represents the current master @ f0450de

Unrelated to that Release-Notes can be viewed from here:
https://github.com/ktoso/maven-git-commit-id-plugin/releases.atom

[TheSnoozer]

I added release-notes until 2.1.9 which was released back in Feb 9, 2014. Now creating release-notes is getting tricky since not all commits have an related issue....
not sure if it would be worth to dig through the commits itself (e.g. with the compare view a9dba4a...aade0c5)

git show-ref --tags
16c85b8d649a34c40056355af1e1f82b0d2c9d76 refs/tags/v1.0
ab60db7e7fedcae077af509e6192add421bfbb12 refs/tags/v1.1
3f437b3a14f0fed84f8786d5d7051bb5c0d6936c refs/tags/v1.2
e89f1e7e8e7f24624ed9d19e1d35898339266072 refs/tags/v1.3
971316a891441fbc2635e33ee9c79cf183d71dbb refs/tags/v1.4
8a2e16427355862573140fe9baa1e82ec2e921c6 refs/tags/v1.5
473aa600d2c22fc4a008d1c1d8cf50562fef5876 refs/tags/v1.6
e4da6e59adc8a7de9f029ea3cba8ec0d0b576e13 refs/tags/v1.7
b683a0108b943343f0cc0783e8309f8750f2b78c refs/tags/v1.8
0ec2c72916ce8ae1db819f1dc78b9a2f1e611396 refs/tags/v1.9
1740fbbddc35a2c3d7da5421ee4eb61b90664802 refs/tags/v2.0
bd5328a463ef29ec2bd6a7ecf8e51af61a9882ab refs/tags/v2.0.1
f0c5ac406ddde0a45a885e0ebb7eed15252d487a refs/tags/v2.0.2
28728f43f6a9619e78c560830f1db98e271cec07 refs/tags/v2.0.3
9b0ee30af97d4ae17dffb11bd06ed67fc4451547 refs/tags/v2.0.4
293440c02d063ef408617fcb161886aa594790f2 refs/tags/v2.1.0
8430b98d30ae334478284220987295b541d53bc1 refs/tags/v2.1.1
c8896750c7555d598fe82f1bc8781fd9a9de22b7 refs/tags/v2.1.10
56c5a491720ce35ae8f8626be1d3414728f1b953 refs/tags/v2.1.11
e9879658209ee81d7bf50ceedd028737f0b1cd0c refs/tags/v2.1.12
5a59dc48c6e09f8cdd99cac440e3ffe44ff4d8a6 refs/tags/v2.1.13
c6ad6d812461398f957aaba49411bd157849b443 refs/tags/v2.1.14
1e2b8c87ff15d655f77b594d011d1d940bd82ad9 refs/tags/v2.1.15
4a9960164a0c7694de1b3706375af79385604162 refs/tags/v2.1.2
997cc7b55e9a7cb9f65bf72be4c7585c7c31f244 refs/tags/v2.1.3
4678f24625d5ecd34775f3d6a54d7d727d1aec98 refs/tags/v2.1.4
e514a2379d729e6fdf58c86d377d36b9462d6b8b refs/tags/v2.1.5
9af99a3eefb06ec12e3a3b406b958df98584054d refs/tags/v2.1.6
c1f780117920dcf7056f18342b9e075372aa0583 refs/tags/v2.1.7
6f67c8f7d6eb0f0829d41eda20b474487204bfe8 refs/tags/v2.1.8
a961039c0ae31eb2bc6212ba5f4901f20cd3f9ce refs/tags/v2.1.9
9f45e5171b7e859d20c40d461b590d5605e74db0 refs/tags/v2.2.0
1f3f8411957daadae0c5afc676c6e257b9626760 refs/tags/v2.2.1
97e198d81ef5ee4eed512d0d5697e1228867696c refs/tags/v2.2.2
13568453841ab43ec372487d66598c9755eaeba9 refs/tags/v2.2.3