Merge pull request #115 from bci-oss/#114-release-milestones-to-github

#114 release milestones to GitHub

Author: atextor

.github/workflows/release-workflow.yml

@@ -5,6 +5,9 @@ on:
       release_version:
         description: 'Version number of the release'
         required: true
+      milestone_version:
+        description: '"true" if a milestone release shall be published'
+        required: false
 jobs:
   build:
     runs-on: ubuntu-20.04
@@ -65,7 +68,10 @@ jobs:
           git push origin ${{ env.release_branch_name }}
       - name: Run tests and build
         run: mvn -B clean install
+
+# release-build
       - name: Create GitHub release
+        condition: eq( '${{ github.event.inputs.release_version }}', 'true')
         uses: softprops/action-gh-release@v1
         id: sds_sdk_release
         with: 
@@ -79,8 +85,30 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN  }}
       - name: Publish to OSSRH
-        run: mvn -B clean -pl '!sds-sdk-test-report,!tools/bamm-cli' deploy -DskipTests
+        condition: eq( '${{ github.event.inputs.release_version }}', 'true')
+        run: mvn -B clean -pl '!sds-sdk-test-report,!tools/bamm-cli' deploy -DskipTests -Prelease-build
         env:
           OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
           OSSRH_TOKEN: ${{ secrets.OSSRH_TOKEN }}
           PGP_KEY_PASSWORD: ${{ secrets.PGP_KEY_PASSWORD }}
+
+# milestone-build
+      - name: Create GitHub release
+        condition: ne( '${{ github.event.inputs.release_version }}', 'true')
+        uses: softprops/action-gh-release@v1
+        id: sds_sdk_release
+        with:
+          body: "Release of the BAMM SDK in version v${{ github.event.inputs.release_version  }}."
+          tag_name: v${{ github.event.inputs.release_version }}
+          target_commitish: ${{ env.release_branch_name }}
+          draft: false
+          prerelease: true
+          files: |
+            **/target/*-${{ github.event.inputs.release_version }}.jar
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN  }}
+      - name: Publish to Github
+        condition: ne( '${{ github.event.inputs.release_version }}', 'true')
+        run: mvn -B clean -pl '!sds-sdk-test-report,!tools/bamm-cli' deploy -DskipTests -Pmilestone-build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN  }}

README.md

@@ -13,7 +13,6 @@
 - [Version Handling](#version-handling)
     - [BAMM Versioning](#bamm-versioning)
     - [BAMM Java Implementation Packaging](#bamm-java-implementation-packaging)
-    - [API Versioning](#api-versioning)
 - [BAMM CLI](#bamm-cli)
 - [Artifact Generation facilities](#artifact-generation-facilities)
     - [POJO Generator](#pojo-generator)
@@ -113,6 +112,9 @@ manner, some changes cannot be carried out without the need to define a new, bre
 important to understand the versioning concept that is applied to the BAMM, APIs and SDK components that are derived
 from them.
 
+In case of a prerelease there will be a postfix added and it will be released under Github.
+The way to access the artifact is described in [Github-Installing a package](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#installing-a-package)
+
 ### BAMM Versioning
 
 For the BAMM, semantic versioning (`major.minor.micro`) is applied with the following rules:

pom.xml

@@ -344,7 +344,6 @@
          </dependency>
       </dependencies>
    </dependencyManagement>
-
    <build>
       <pluginManagement>
          <plugins>
@@ -520,24 +519,43 @@
                </gpgArguments>
             </configuration>
          </plugin>
-         <plugin>
-            <groupId>org.sonatype.plugins</groupId>
-            <artifactId>nexus-staging-maven-plugin</artifactId>
-            <version>1.6.7</version>
-            <extensions>true</extensions>
-            <configuration>
-               <serverId>ossrh</serverId>
-               <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
-               <autoReleaseAfterClose>false</autoReleaseAfterClose>
-            </configuration>
-         </plugin>
       </plugins>
    </build>
-   <distributionManagement>
-      <repository>
-         <id>ossrh</id>
-         <name>OSSRH</name>
-         <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
-      </repository>
-   </distributionManagement>
+   <profiles>
+      <profile>
+         <id>release-build</id>
+         <distributionManagement>
+            <repository>
+               <id>ossrh</id>
+               <name>OSSRH</name>
+               <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
+            </repository>
+         </distributionManagement>
+         <build>
+            <plugins>
+               <plugin>
+                  <groupId>org.sonatype.plugins</groupId>
+                  <artifactId>nexus-staging-maven-plugin</artifactId>
+                  <version>1.6.7</version>
+                  <extensions>true</extensions>
+                  <configuration>
+                     <serverId>ossrh</serverId>
+                     <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
+                     <autoReleaseAfterClose>false</autoReleaseAfterClose>
+                  </configuration>
+               </plugin>
+            </plugins>
+         </build>
+      </profile>
+      <profile>
+         <id>milestone-build</id>
+         <distributionManagement>
+            <repository>
+               <id>github</id>
+               <name>Github</name>
+               <url>https://maven.pkg.github.com/OpenManufacturingPlatform/sds-sdk</url>
+            </repository>
+         </distributionManagement>
+      </profile>
+   </profiles>
 </project>