Update README and polish artifacts

Author: mpkorstanje

.github/workflows/release-github.yaml

@@ -15,34 +15,6 @@ jobs:
       contents: write
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-java@v5
-        with:
-          distribution: 'temurin'
-          java-version: '21'
-          cache: 'maven'
-      - run: |
-          mvn verify
-          # Test if the jar file works
-          ./target/app/bin/cucumber-messages-cli --help
-        working-directory: java
       - uses: cucumber/[email protected]
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
-      - name: upload Unix artifact
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ github.token }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: java/target/distributions/app/cucumber-messages-cli.tar.gz
-          asset_name: cucumber-messages-cli.tar.gz
-          asset_content_type: application/gzip
-      - name: upload Windows artifact
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ github.token }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: java/target/distributions/app/cucumber-messages-cli.zip
-          asset_name: cucumber-messages-cli.zip
-          asset_content_type: application/zip

.github/workflows/test-java.yml

@@ -41,6 +41,6 @@ jobs:
       - run: | 
           mvn verify
           # Test if the jar file works
-          ./target/app/bin/cucumber-messages-cli --help
+          ./target/app/cucumber-messages-cli/bin/cucumber-messages --help
         working-directory: java
 

CHANGELOG.md

@@ -6,10 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-
-## [0.0.1] - 2025-12-11
 ### Changed
 - Initial release
 
-[Unreleased]: https://github.com/cucumber/messages-cli/compare/v0.0.1...HEAD
-[0.0.1]: https://github.com/cucumber/messages-cli/compare/1c14a4838e49c7c0b02c09d884b9c783790070f0...v0.0.1
+[Unreleased]: https://github.com/cucumber/messages-cli/compare/1c14a4838e49c7c0b02c09d884b9c783790070f0...HEAD

README.md

@@ -1,9 +1,44 @@
 # messages-cli
+
 Commandline interface to work with Cucumber Messages
 
-## TODO:
- - Build as standalone artifact
- - Publish as a CLI tool
- - Write README.
- - Tidelift
- - Support JSON Formatter
+Given a messages file produce a test report in one of these format: 
+
+* JUnit XML
+* TestNG XML
+* Cucumber HTML
+* Cucumber JSON
+
+## Building
+
+Required
+* Apache Maven 3.9.9+
+* Java JRE 21+
+
+First, checkout the latest release `X.Y.Z`: 
+
+```
+git clone https://github.com/cucumber/messages-cli.git
+git checkout vX.Y.Z
+```
+
+Then build the project
+
+```shell
+cd java 
+mvn clean package
+```
+
+Then install the artifacts, for example on Unix:
+
+```shell
+cp -r target/app/cucumber-messages-cli ~/opt
+ln -s ~/opt/cucumber-messages-cli/bin/cucumber-messages ~/.local/bin/cucumber-messages
+```
+
+On Windows: copy the `target/app/cucumber-messages-cli` somewhere and put the
+`cucumber-messages.bat` in your `PATH`.
+
+## Usage
+
+See: `cucumber-messages --help`

java/pom.xml

@@ -28,7 +28,7 @@
 
         <app.distribution.directory>${project.build.directory}/distributions/app</app.distribution.directory>
         <app.main.class>io.cucumber.messages.cli.CucumberMessagesCli</app.main.class>
-        <app.main.id>cucumber-messages-cli</app.main.id>
+
     </properties>
 
     <scm>
@@ -141,13 +141,13 @@
                 <artifactId>appassembler-maven-plugin</artifactId>
                 <version>2.1.0</version>
                 <configuration>
-                    <assembleDirectory>${project.build.directory}/app</assembleDirectory>
+                    <assembleDirectory>${project.build.directory}/app/${project.artifactId}</assembleDirectory>
                     <repositoryLayout>flat</repositoryLayout>
                     <repositoryName>lib</repositoryName>
                     <programs>
                         <program>
                             <mainClass>${app.main.class}</mainClass>
-                            <id>${app.main.id}</id>
+                            <id>cucumber-messages</id>
                         </program>
                     </programs>
                 </configuration>

java/src/main/assembly/assembly.xml

@@ -16,7 +16,7 @@
             <outputDirectory></outputDirectory>
         </fileSet>
         <fileSet>
-            <directory>${project.build.directory}/app</directory>
+            <directory>${project.build.directory}/app/{$project.artifactId}</directory>
             <outputDirectory></outputDirectory>
         </fileSet>
     </fileSets>