release process: add changelog info to gibhub release page?
36 views
Skip to first unread message
Stefan Seifert
Mar 4, 2020, 1:55:57 AM3/4/20
to mojoha...@googlegroups.com
(from the discussion in [1])
currently, releases for mojos in github only show the plain list of release tag names - example: [2]. leaving it to the user to find the list of issues that were fixed (e.g. in the maven site's github report).
by using the GitHub UI it's possible to add a link to the changelog (which is usual in a lot of github projects), example in build-helper-maven-plugin 3.1.0 [3]. this is a release draft create by me yesterday.
the question is: do we want to add this step in general to the release process for new releases, or prefer to keep the plain list of tag names.
adding the additional release information is a manual step (which is always bad for a release process). it may be possible to automate it with plugins like [4], but i've not tried it, and this plugin adds additional complexity to the release process as another token-based authentication needs to be setup.
i'm fine with either way, just wanted to ask to make the releases consistent.
if no one votes for adding more information to release tags in github (manual step), i will remove the changelog link for the latest build-helper-maven-plugin to make it consistent again.
stefan
[1] https://groups.google.com/d/msgid/mojohaus-dev/CAKDUN1vGL1qNjo5QTRoUuc-zH8yyo7qoy3JV53D2t-zwE38UxA%40mail.gmail.com?utm_medium=email&utm_source=footer
[2] https://github.com/mojohaus/license-maven-plugin/releases
[3] https://github.com/mojohaus/build-helper-maven-plugin/releases
[4] https://github.com/RagedUnicorn/github-release-maven-plugin
currently, releases for mojos in github only show the plain list of release tag names - example: [2]. leaving it to the user to find the list of issues that were fixed (e.g. in the maven site's github report).
by using the GitHub UI it's possible to add a link to the changelog (which is usual in a lot of github projects), example in build-helper-maven-plugin 3.1.0 [3]. this is a release draft create by me yesterday.
the question is: do we want to add this step in general to the release process for new releases, or prefer to keep the plain list of tag names.
adding the additional release information is a manual step (which is always bad for a release process). it may be possible to automate it with plugins like [4], but i've not tried it, and this plugin adds additional complexity to the release process as another token-based authentication needs to be setup.
i'm fine with either way, just wanted to ask to make the releases consistent.
if no one votes for adding more information to release tags in github (manual step), i will remove the changelog link for the latest build-helper-maven-plugin to make it consistent again.
stefan
[1] https://groups.google.com/d/msgid/mojohaus-dev/CAKDUN1vGL1qNjo5QTRoUuc-zH8yyo7qoy3JV53D2t-zwE38UxA%40mail.gmail.com?utm_medium=email&utm_source=footer
[2] https://github.com/mojohaus/license-maven-plugin/releases
[3] https://github.com/mojohaus/build-helper-maven-plugin/releases
[4] https://github.com/RagedUnicorn/github-release-maven-plugin
Olivier Lamy
Mar 4, 2020, 10:10:41 PM3/4/20
to mojoha...@googlegroups.com
LGTM as long as it's only a simple link to the issues.
--
You received this message because you are subscribed to the Google Groups "mojohaus-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to mojohaus-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/mojohaus-dev/5c4d54d4066f4136a406e7101b7703a4%40mailx01.intern.pro-vision.de.
Anders Hammar
Mar 5, 2020, 2:42:30 AM3/5/20
to mojoha...@googlegroups.com
I concur with Olivier. However, I think that the release draft should be updated AFTER the vote has passed. This to prevent users from thinking that it has been released already. As you've seen yourself [1] it is already too confusing when we publish the new site before the release has actually been made. We shouldn't make this worse.
/Anders
To view this discussion on the web visit https://groups.google.com/d/msgid/mojohaus-dev/CAPoyBqTOwNGn18zBCFQVc3%2BwA6JDvD7OjeT10fQaa2gZMzEL3w%40mail.gmail.com.
Stefan Seifert
Mar 5, 2020, 3:00:45 AM3/5/20
to mojoha...@googlegroups.com
use the github feature to mark a release explicitly as "draft" (pre-release), and und-draft it when the vote has passed. than we can add the changelog link.
as an example I've just done this for the build-helper-maven-plugin release:
https://github.com/mojohaus/build-helper-maven-plugin/releases
stefan
From: mojoha...@googlegroups.com <mojoha...@googlegroups.com> On Behalf Of Anders Hammar
Sent: Thursday, March 5, 2020 8:42 AM
To: mojoha...@googlegroups.com
Subject: Re: release process: add changelog info to gibhub release page?
I concur with Olivier. However, I think that the release draft should be updated AFTER the vote has passed. This to prevent users from thinking that it has been released already. As you've seen yourself [1] it is already too confusing when we publish the new site before the release has actually been made. We shouldn't make this worse.
[1] https://github.com/mojohaus/build-helper-maven-plugin/commit/ba766004f0f4261c5a33686f06210b40f92a0fdd#r37628132
/Anders
To view this discussion on the web visit https://groups.google.com/d/msgid/mojohaus-dev/CAPoyBqTOwNGn18zBCFQVc3%2BwA6JDvD7OjeT10fQaa2gZMzEL3w%40mail.gmail.com?utm_medium=email&utm_source=footer.
To view this discussion on the web visit https://groups.google.com/d/msgid/mojohaus-dev/CAKDUN1uTpE%3Drkz3R_vqqyYnU-YZPX12MiyuhAYgEVga7BFqA2A%40mail.gmail.com?utm_medium=email&utm_source=footer.
as an example I've just done this for the build-helper-maven-plugin release:
https://github.com/mojohaus/build-helper-maven-plugin/releases
stefan
From: mojoha...@googlegroups.com <mojoha...@googlegroups.com> On Behalf Of Anders Hammar
Sent: Thursday, March 5, 2020 8:42 AM
To: mojoha...@googlegroups.com
Subject: Re: release process: add changelog info to gibhub release page?
I concur with Olivier. However, I think that the release draft should be updated AFTER the vote has passed. This to prevent users from thinking that it has been released already. As you've seen yourself [1] it is already too confusing when we publish the new site before the release has actually been made. We shouldn't make this worse.
[1] https://github.com/mojohaus/build-helper-maven-plugin/commit/ba766004f0f4261c5a33686f06210b40f92a0fdd#r37628132
/Anders
On Thu, Mar 5, 2020 at 4:10 AM Olivier Lamy <mailto:olive...@gmail.com> wrote:
LGTM as long as it's only a simple link to the issues.
On Wed, 4 Mar 2020 at 16:55, Stefan Seifert <mailto:ssei...@pro-vision.de> wrote:
(from the discussion in [1])
currently, releases for mojos in github only show the plain list of release tag names - example: [2]. leaving it to the user to find the list of issues that were fixed (e.g. in the maven site's github report).
by using the GitHub UI it's possible to add a link to the changelog (which is usual in a lot of github projects), example in build-helper-maven-plugin 3.1.0 [3]. this is a release draft create by me yesterday.
the question is: do we want to add this step in general to the release process for new releases, or prefer to keep the plain list of tag names.
adding the additional release information is a manual step (which is always bad for a release process). it may be possible to automate it with plugins like [4], but i've not tried it, and this plugin adds additional complexity to the release process as another token-based authentication needs to be setup.
i'm fine with either way, just wanted to ask to make the releases consistent.
if no one votes for adding more information to release tags in github (manual step), i will remove the changelog link for the latest build-helper-maven-plugin to make it consistent again.
stefan
[1] https://groups.google.com/d/msgid/mojohaus-dev/CAKDUN1vGL1qNjo5QTRoUuc-zH8yyo7qoy3JV53D2t-zwE38UxA%40mail.gmail.com?utm_medium=email&utm_source=footer
[2] https://github.com/mojohaus/license-maven-plugin/releases
[3] https://github.com/mojohaus/build-helper-maven-plugin/releases
[4] https://github.com/RagedUnicorn/github-release-maven-plugin
--
You received this message because you are subscribed to the Google Groups "mojohaus-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to mailto:mojohaus-dev%2Bunsu...@googlegroups.com.
LGTM as long as it's only a simple link to the issues.
On Wed, 4 Mar 2020 at 16:55, Stefan Seifert <mailto:ssei...@pro-vision.de> wrote:
(from the discussion in [1])
currently, releases for mojos in github only show the plain list of release tag names - example: [2]. leaving it to the user to find the list of issues that were fixed (e.g. in the maven site's github report).
by using the GitHub UI it's possible to add a link to the changelog (which is usual in a lot of github projects), example in build-helper-maven-plugin 3.1.0 [3]. this is a release draft create by me yesterday.
the question is: do we want to add this step in general to the release process for new releases, or prefer to keep the plain list of tag names.
adding the additional release information is a manual step (which is always bad for a release process). it may be possible to automate it with plugins like [4], but i've not tried it, and this plugin adds additional complexity to the release process as another token-based authentication needs to be setup.
i'm fine with either way, just wanted to ask to make the releases consistent.
if no one votes for adding more information to release tags in github (manual step), i will remove the changelog link for the latest build-helper-maven-plugin to make it consistent again.
stefan
[1] https://groups.google.com/d/msgid/mojohaus-dev/CAKDUN1vGL1qNjo5QTRoUuc-zH8yyo7qoy3JV53D2t-zwE38UxA%40mail.gmail.com?utm_medium=email&utm_source=footer
[2] https://github.com/mojohaus/license-maven-plugin/releases
[3] https://github.com/mojohaus/build-helper-maven-plugin/releases
[4] https://github.com/RagedUnicorn/github-release-maven-plugin
--
You received this message because you are subscribed to the Google Groups "mojohaus-dev" group.
To view this discussion on the web visit https://groups.google.com/d/msgid/mojohaus-dev/5c4d54d4066f4136a406e7101b7703a4%40mailx01.intern.pro-vision.de.
--
Olivier Lamy
http://twitter.com/olamy | http://linkedin.com/in/olamy
--
You received this message because you are subscribed to the Google Groups "mojohaus-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to mailto:mojohaus-dev...@googlegroups.com.
--
Olivier Lamy
http://twitter.com/olamy | http://linkedin.com/in/olamy
--
You received this message because you are subscribed to the Google Groups "mojohaus-dev" group.
To view this discussion on the web visit https://groups.google.com/d/msgid/mojohaus-dev/CAPoyBqTOwNGn18zBCFQVc3%2BwA6JDvD7OjeT10fQaa2gZMzEL3w%40mail.gmail.com?utm_medium=email&utm_source=footer.
--
You received this message because you are subscribed to the Google Groups "mojohaus-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to mailto:mojohaus-dev...@googlegroups.com.
You received this message because you are subscribed to the Google Groups "mojohaus-dev" group.
To view this discussion on the web visit https://groups.google.com/d/msgid/mojohaus-dev/CAKDUN1uTpE%3Drkz3R_vqqyYnU-YZPX12MiyuhAYgEVga7BFqA2A%40mail.gmail.com?utm_medium=email&utm_source=footer.
Mark Prins
Mar 5, 2020, 5:47:32 AM3/5/20
to mojohaus-dev
Bots like @dependabot will use the github release notes to add in to any PR it creates, it won't do that with externally hosted changelists
Mirko Friedenhagen
Mar 5, 2020, 10:01:10 AM3/5/20
to mojoha...@googlegroups.com
I agree with Olivier here, a simple link does no harm. However we should then harmonize the releases and adapt the procedure documentation accordingly.
Best Regards
Mirko Friedenhagen
—
Sent from my mobile
Am 05.03.20 um 04:10 schrieb Olivier Lamy
> To view this discussion on the web visit https://groups.google.com/d/msgid/mojohaus-dev/CAPoyBqTOwNGn18zBCFQVc3%2BwA6JDvD7OjeT10fQaa2gZMzEL3w%40mail.gmail.com.
Best Regards
Mirko Friedenhagen
—
Sent from my mobile
Am 05.03.20 um 04:10 schrieb Olivier Lamy
Stefan Seifert
Mar 10, 2020, 5:33:13 AM3/10/20
to mojoha...@googlegroups.com
i've created a PR to add this step to the release process
https://github.com/mojohaus/mojohaus.github.io/pull/35
stefan
https://github.com/mojohaus/mojohaus.github.io/pull/35
stefan
Olivier Lamy
Mar 10, 2020, 9:41:29 PM3/10/20
to mojoha...@googlegroups.com
Thanks a lot.
It's merged
To view this discussion on the web visit https://groups.google.com/d/msgid/mojohaus-dev/14d93b8dc2e5405082be2a9fb1f0657d%40mailx01.intern.pro-vision.de.
Reply all
Reply to author
Forward
0 new messages