Re: User friendly release notes
Hi, > On 13. Mar 2024, at 23:58, Slawomir Jaranowski wrote: > > It looks as most usable will be to manage release notes also in GitHub at > least as link to jira public url for release notes. > Yes I know we don't have (or have old one like maven-changes-plugin) > perfect tools to help with this process. The changes plugin isn't maintained anymore and is buggy wrt. GitHub. For that reason, in Apache UIMA, we have switched to using the `gh` command line to tool to generate release notes. https://github.com/apache/uima-parent-pom/blob/main/pom.xml#L1036-L1087 This one is *not* based on commit messages and therefore does not require strong discipline. It is rather based on PR titles which can also be changed if necessary shortly before a release. The output is (currently) still manually post-processed to make it a bit nicer (e.g. with emojis) and embed it into a larger release notes document... but the plan is to eventually automate that away as well. Here is an example raw output from the tool: https://svn.apache.org/repos/asf/uima/site/archive/docs/d/uimaj-3.5.0/issuesFixed/github-report.md Here is an example release note from UIMA: https://github.com/apache/uima-uimaj/releases/tag/rel%2Fuimaj-3.5.0 Cheers, -- Richard - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org
Re: User friendly release notes
What's wrong with using a changes.xml and the plug in? You have full control. Gary On Wed, Mar 13, 2024, 7:25 PM Elliotte Rusty Harold wrote: > On Wed, Mar 13, 2024 at 7:07 PM Andres Almiray wrote: > > > > First, I’d suggest following a commit message convention. You may define > your own or follow an existing one such as > https://www.conventionalcommits.org/en/v1.0.0/ > > > > Please don't. I've seen this on too many projects, and it's a huge > hassle for very little benefit. It would take significantly less time > to manually write release notes for each release than to micro-format > each and every commit message. Conventional commits is a huge time > sink and way too much added friction. It discourages developers and > decreases velocity with endless nit picking over formatting details > that just don't matter. > > -- > Elliotte Rusty Harold > elh...@ibiblio.org > > - > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org > For additional commands, e-mail: dev-h...@maven.apache.org > >
Re: User friendly release notes
On Wed, Mar 13, 2024 at 7:07 PM Andres Almiray wrote: > > First, I’d suggest following a commit message convention. You may define your > own or follow an existing one such as > https://www.conventionalcommits.org/en/v1.0.0/ > Please don't. I've seen this on too many projects, and it's a huge hassle for very little benefit. It would take significantly less time to manually write release notes for each release than to micro-format each and every commit message. Conventional commits is a huge time sink and way too much added friction. It discourages developers and decreases velocity with endless nit picking over formatting details that just don't matter. -- Elliotte Rusty Harold elh...@ibiblio.org - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org
Re: User friendly release notes
First, I’d suggest following a commit message convention. You may define your own or follow an existing one such as https://www.conventionalcommits.org/en/v1.0.0/ Next, use a tool that can read, parse, and format commit messages. You’ll find plenty of options out there. I can pitch https://jreleaser.org/ 😉 Cheers Andres Sent from my primitive tricorder > On 13 Mar 2024, at 23:58, Slawomir Jaranowski wrote: > > Hi, > > Today's facts: > > - We manage our issues in jira and all officala release notes are also in > jira. > - We sent an email in text format to announce mailing list. > - In project documentation we don't have a release notes > > But as we see in: > https://lists.apache.org/thread/pzd36lo6rtfn7c5s0x60xbj296xt1mvf > today it is not a user-friendly way. > > It looks as most usable will be to manage release notes also in GitHub at > least as link to jira public url for release notes. > Yes I know we don't have (or have old one like maven-changes-plugin) > perfect tools to help with this process. > > Any other propositions, ideas ? > > -- > Sławomir Jaranowski
User friendly release notes
Hi, Today's facts: - We manage our issues in jira and all officala release notes are also in jira. - We sent an email in text format to announce mailing list. - In project documentation we don't have a release notes But as we see in: https://lists.apache.org/thread/pzd36lo6rtfn7c5s0x60xbj296xt1mvf today it is not a user-friendly way. It looks as most usable will be to manage release notes also in GitHub at least as link to jira public url for release notes. Yes I know we don't have (or have old one like maven-changes-plugin) perfect tools to help with this process. Any other propositions, ideas ? -- Sławomir Jaranowski
Re: [ANN] Apache Maven Assembly Plugin 3.7.0 Released
Hi The announcement mail doesn't contain any links :-) The official release notes are in jira but Filipe has a right it is not easy to get it by users without jira accounts. I will start a new thread with discussion on how we can provide release notes for users in ease and usable form. śr., 13 mar 2024 o 12:29 Tamás Cservenák napisał(a): > Howdy, > > The announcement mail by mistake had the wrong link... Sorry about that. > > The mail should have this one instead: > > https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12317220&version=12353243 > > Thanks > T > > On Wed, Mar 13, 2024 at 12:16 PM Filipe Roque > wrote: > > > Hi, > > > > What is the oficial way to read the release notes about a plugin > > version ? > > > > > > The link > > https://issues.apache.org/jira/projects/MASSEMBLY/versions/12353243 > > requires a JIRA account > > > > The link > > > > > https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12317220&version=12353243 > > is public but could only find it using a JIRA account > > > > > > Could not find any release notes information in > > https://maven.apache.org/plugins/maven-assembly-plugin/index.html > > > > > > Github releases > > (https://github.com/apache/maven-assembly-plugin/releases) also do not > > contain any release notes. > > > > There is this email announcement but is not easy way to find release > > notes. > > > > > > Filipe Roque > > > > > > On Mon, 2024-03-11 at 00:09 +0100, Slawomir Jaranowski wrote: > > > The Apache Maven team is pleased to announce the release of the > > > Apache > > > Maven Assembly Plugin, version 3.7.0 > > > > > > The Assembly Plugin for Maven enables developers to combine project > > > output > > > into a single distributable archive that also contains dependencies, > > > modules, site documentation, and other files. > > > > > > > > > https://maven.apache.org/plugins/maven-assembly-plugin/ > > > > > > You should specify the version in your project's plugin > > > configuration: > > > > > > > > > org.apache.maven.plugins > > > maven-assembly-plugin > > > 3.7.0 > > > > > > > > > You can download the appropriate sources etc. from the download page: > > > > > > https://maven.apache.org/plugins/maven-assembly-plugin/download.cgi > > > > > > Release Notes - Maven Assembly Plugin - Version 3.7.0 > > > > > > ** Bug > > > * [MASSEMBLY-967] - maven-assembly-plugin doesn't add > > > target/class > > > artifacts in generated jarfat but META-INF/MANIFEST.MF seems to be > > > correct > > > * [MASSEMBLY-994] - Items from unpacked dependency are not > > > refreshed > > > * [MASSEMBLY-998] - Transitive dependencies are not properly > > > excluded > > > as of 3.1.1 > > > * [MASSEMBLY-1008] - Assembly plugin handles scopes wrongly > > > * [MASSEMBLY-1018] - Fix examples about useStrictFiltering > > > > > > ** New Feature > > > * [MASSEMBLY-992] - Facility to define assembly descriptor in > > > body of > > > POM > > > > > > ** Improvement > > > * [MASSEMBLY-1007] - Upgrade maven-plugin parent to 41 > > > * [MASSEMBLY-1016] - clarify and fix plugin system requirements > > > history > > > * [MASSEMBLY-1017] - Don't use deprecated methods in code > > > > > > ** Task > > > * [MASSEMBLY-991] - XSDs for 2.2.0 missing from Maven Project Web > > > Site > > > * [MASSEMBLY-1000] - ITs - cleanups, refresh plugins versions > > > * [MASSEMBLY-1003] - Remove unused remoteRepositories > > > * [MASSEMBLY-1004] - Remove ignored and deprecated parameter - > > > useJvmChmod > > > * [MASSEMBLY-1010] - Use IOUtils from commons-io instead of > > > plexus > > > * [MASSEMBLY-1013] - Code cleanups > > > > > > ** Dependency upgrade > > > * [MASSEMBLY-995] - Bump org.codehaus.plexus:plexus-archiver from > > > 4.7.1 > > > to 4.9.1 > > > * [MASSEMBLY-996] - Bump zstd-jni from 1.5.5-4 to 1.5.5-11 > > > * [MASSEMBLY-997] - Bump commons-io from 2.11.0 to 2.13.0 > > > * [MASSEMBLY-999] - Upgrade Parent to 40 > > > * [MASSEMBLY-1009] - Bump commons-io from 2.13.0 to 2.15.1 > > > * [MASSEMBLY-1011] - Bump maven-archiver from 3.6.0 to 3.6.1 > > > * [MASSEMBLY-1012] - Bump org.apache.commons:commons-compress > > > from > > > 1.23.0 to 1.25.0 > > > * [MASSEMBLY-1014] - Bump org.codehaus.plexus:plexus- > > > interpolation from > > > 1.26 to 1.27 > > > * [MASSEMBLY-1015] - Bump org.codehaus.plexus:plexus-io from > > > 3.4.1 to > > > 3.4.2 > > > * [MASSEMBLY-1019] - Maven 3.6.3 as minimum requirements > > > > > > Enjoy, > > > > > > -The Apache Maven team > > > > > > - > > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org > > For additional commands, e-mail: dev-h...@maven.apache.org > > > -- Sławomir Jaranowski
Re: [ANN] Apache Maven Assembly Plugin 3.7.0 Released
Howdy, The announcement mail by mistake had the wrong link... Sorry about that. The mail should have this one instead: https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12317220&version=12353243 Thanks T On Wed, Mar 13, 2024 at 12:16 PM Filipe Roque wrote: > Hi, > > What is the oficial way to read the release notes about a plugin > version ? > > > The link > https://issues.apache.org/jira/projects/MASSEMBLY/versions/12353243 > requires a JIRA account > > The link > > https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12317220&version=12353243 > is public but could only find it using a JIRA account > > > Could not find any release notes information in > https://maven.apache.org/plugins/maven-assembly-plugin/index.html > > > Github releases > (https://github.com/apache/maven-assembly-plugin/releases) also do not > contain any release notes. > > There is this email announcement but is not easy way to find release > notes. > > > Filipe Roque > > > On Mon, 2024-03-11 at 00:09 +0100, Slawomir Jaranowski wrote: > > The Apache Maven team is pleased to announce the release of the > > Apache > > Maven Assembly Plugin, version 3.7.0 > > > > The Assembly Plugin for Maven enables developers to combine project > > output > > into a single distributable archive that also contains dependencies, > > modules, site documentation, and other files. > > > > > > https://maven.apache.org/plugins/maven-assembly-plugin/ > > > > You should specify the version in your project's plugin > > configuration: > > > > > > org.apache.maven.plugins > > maven-assembly-plugin > > 3.7.0 > > > > > > You can download the appropriate sources etc. from the download page: > > > > https://maven.apache.org/plugins/maven-assembly-plugin/download.cgi > > > > Release Notes - Maven Assembly Plugin - Version 3.7.0 > > > > ** Bug > > * [MASSEMBLY-967] - maven-assembly-plugin doesn't add > > target/class > > artifacts in generated jarfat but META-INF/MANIFEST.MF seems to be > > correct > > * [MASSEMBLY-994] - Items from unpacked dependency are not > > refreshed > > * [MASSEMBLY-998] - Transitive dependencies are not properly > > excluded > > as of 3.1.1 > > * [MASSEMBLY-1008] - Assembly plugin handles scopes wrongly > > * [MASSEMBLY-1018] - Fix examples about useStrictFiltering > > > > ** New Feature > > * [MASSEMBLY-992] - Facility to define assembly descriptor in > > body of > > POM > > > > ** Improvement > > * [MASSEMBLY-1007] - Upgrade maven-plugin parent to 41 > > * [MASSEMBLY-1016] - clarify and fix plugin system requirements > > history > > * [MASSEMBLY-1017] - Don't use deprecated methods in code > > > > ** Task > > * [MASSEMBLY-991] - XSDs for 2.2.0 missing from Maven Project Web > > Site > > * [MASSEMBLY-1000] - ITs - cleanups, refresh plugins versions > > * [MASSEMBLY-1003] - Remove unused remoteRepositories > > * [MASSEMBLY-1004] - Remove ignored and deprecated parameter - > > useJvmChmod > > * [MASSEMBLY-1010] - Use IOUtils from commons-io instead of > > plexus > > * [MASSEMBLY-1013] - Code cleanups > > > > ** Dependency upgrade > > * [MASSEMBLY-995] - Bump org.codehaus.plexus:plexus-archiver from > > 4.7.1 > > to 4.9.1 > > * [MASSEMBLY-996] - Bump zstd-jni from 1.5.5-4 to 1.5.5-11 > > * [MASSEMBLY-997] - Bump commons-io from 2.11.0 to 2.13.0 > > * [MASSEMBLY-999] - Upgrade Parent to 40 > > * [MASSEMBLY-1009] - Bump commons-io from 2.13.0 to 2.15.1 > > * [MASSEMBLY-1011] - Bump maven-archiver from 3.6.0 to 3.6.1 > > * [MASSEMBLY-1012] - Bump org.apache.commons:commons-compress > > from > > 1.23.0 to 1.25.0 > > * [MASSEMBLY-1014] - Bump org.codehaus.plexus:plexus- > > interpolation from > > 1.26 to 1.27 > > * [MASSEMBLY-1015] - Bump org.codehaus.plexus:plexus-io from > > 3.4.1 to > > 3.4.2 > > * [MASSEMBLY-1019] - Maven 3.6.3 as minimum requirements > > > > Enjoy, > > > > -The Apache Maven team > > > - > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org > For additional commands, e-mail: dev-h...@maven.apache.org >
Re: [ANN] Apache Maven Assembly Plugin 3.7.0 Released
Hi, What is the oficial way to read the release notes about a plugin version ? The link https://issues.apache.org/jira/projects/MASSEMBLY/versions/12353243 requires a JIRA account The link https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12317220&version=12353243 is public but could only find it using a JIRA account Could not find any release notes information in https://maven.apache.org/plugins/maven-assembly-plugin/index.html Github releases (https://github.com/apache/maven-assembly-plugin/releases) also do not contain any release notes. There is this email announcement but is not easy way to find release notes. Filipe Roque On Mon, 2024-03-11 at 00:09 +0100, Slawomir Jaranowski wrote: > The Apache Maven team is pleased to announce the release of the > Apache > Maven Assembly Plugin, version 3.7.0 > > The Assembly Plugin for Maven enables developers to combine project > output > into a single distributable archive that also contains dependencies, > modules, site documentation, and other files. > > > https://maven.apache.org/plugins/maven-assembly-plugin/ > > You should specify the version in your project's plugin > configuration: > > > org.apache.maven.plugins > maven-assembly-plugin > 3.7.0 > > > You can download the appropriate sources etc. from the download page: > > https://maven.apache.org/plugins/maven-assembly-plugin/download.cgi > > Release Notes - Maven Assembly Plugin - Version 3.7.0 > > ** Bug > * [MASSEMBLY-967] - maven-assembly-plugin doesn't add > target/class > artifacts in generated jarfat but META-INF/MANIFEST.MF seems to be > correct > * [MASSEMBLY-994] - Items from unpacked dependency are not > refreshed > * [MASSEMBLY-998] - Transitive dependencies are not properly > excluded > as of 3.1.1 > * [MASSEMBLY-1008] - Assembly plugin handles scopes wrongly > * [MASSEMBLY-1018] - Fix examples about useStrictFiltering > > ** New Feature > * [MASSEMBLY-992] - Facility to define assembly descriptor in > body of > POM > > ** Improvement > * [MASSEMBLY-1007] - Upgrade maven-plugin parent to 41 > * [MASSEMBLY-1016] - clarify and fix plugin system requirements > history > * [MASSEMBLY-1017] - Don't use deprecated methods in code > > ** Task > * [MASSEMBLY-991] - XSDs for 2.2.0 missing from Maven Project Web > Site > * [MASSEMBLY-1000] - ITs - cleanups, refresh plugins versions > * [MASSEMBLY-1003] - Remove unused remoteRepositories > * [MASSEMBLY-1004] - Remove ignored and deprecated parameter - > useJvmChmod > * [MASSEMBLY-1010] - Use IOUtils from commons-io instead of > plexus > * [MASSEMBLY-1013] - Code cleanups > > ** Dependency upgrade > * [MASSEMBLY-995] - Bump org.codehaus.plexus:plexus-archiver from > 4.7.1 > to 4.9.1 > * [MASSEMBLY-996] - Bump zstd-jni from 1.5.5-4 to 1.5.5-11 > * [MASSEMBLY-997] - Bump commons-io from 2.11.0 to 2.13.0 > * [MASSEMBLY-999] - Upgrade Parent to 40 > * [MASSEMBLY-1009] - Bump commons-io from 2.13.0 to 2.15.1 > * [MASSEMBLY-1011] - Bump maven-archiver from 3.6.0 to 3.6.1 > * [MASSEMBLY-1012] - Bump org.apache.commons:commons-compress > from > 1.23.0 to 1.25.0 > * [MASSEMBLY-1014] - Bump org.codehaus.plexus:plexus- > interpolation from > 1.26 to 1.27 > * [MASSEMBLY-1015] - Bump org.codehaus.plexus:plexus-io from > 3.4.1 to > 3.4.2 > * [MASSEMBLY-1019] - Maven 3.6.3 as minimum requirements > > Enjoy, > > -The Apache Maven team - To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org
