#183: Fixed multi module releases

Author: bbottema

.circleci/config.yml

@@ -1,106 +1,56 @@
 version: 2.1
 
-executors:
-  maven-executor:
-    docker:
-      - image: circleci/openjdk:8u171-jdk
+orbs:
+  github-maven-deploy: github-maven-deploy/github-maven-deploy@dev:22
 
-jobs:
+mvn-build-test-command: &mvn-build-test-command
+  mvn-build-test-command: mvn verify -DexcludeLiveServerTests=true
 
-  build-and-test:
-    executor: maven-executor
-
-    steps:
-      - checkout
-      - restore_cache:
-          key: simple-java-mail-{{ checksum ".circleci/config.yml" }}
-      - run:
-          command: mvn verify -DexcludeLiveServerTests=true
-      - save_cache:
-          paths:
-            - ~/.m2
-          key: simple-java-mail-{{ checksum ".circleci/config.yml" }}
-      - persist_to_workspace:
-          root: .
-          paths:
-            - .
-      - run:
-          shell: /bin/bash -eo pipefail -O globstar
-          command: |
-            mkdir -p artifacts/cli artifacts/coverage artifacts/junit artifacts/javadoc
-            cp **/target/*.jar artifacts/
-            cp modules/cli-module/target/*standalone* artifacts/cli/
-            cp -a target/apidocs/. artifacts/javadoc/
-            cp -a modules/jacoco-aggregator-module/target/site/jacoco-aggregate/. artifacts/coverage/
-            cp -a **/target/surefire-reports/. artifacts/junit
-      - store_artifacts:
-          path: artifacts
-      - store_test_results:
-          path: artifacts/junit
-
-  deploy-patch-version:
-    executor: maven-executor
-    steps:
-      - deploy:
-          versioncommand: mvn build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion} versions:commit
-
-  deploy-minor-version:
-    executor: maven-executor
-    steps:
-      - deploy:
-          versioncommand: mvn build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.nextMinorVersion}.\${parsedVersion.incrementalVersion} versions:commit
-
-  deploy-major-version:
-    executor: maven-executor
-    steps:
-      - deploy:
-          versioncommand: mvn build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.nextMajorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.incrementalVersion} versions:commit
-
-
-commands:
-  deploy:
-    parameters:
-      versioncommand:
-        type: string
-    steps:
-      - attach_workspace:
-          at: .
-      - restore_cache:
-          key: simple-java-mail-{{ checksum ".circleci/config.yml" }}
-      - run:
-          command: |
-            echo "Starting new release..."
-            << parameters.versioncommand >>
-            MVN_VERSION=$(mvn -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive exec:exec)
-            echo "Releasing version ${MVN_VERSION}..."
-            # mvn -s .circleci/maven-release-settings.xml clean deploy nexus-staging:release -DdeployAtEnd=true -DperformRelease=true -DskipTests
-            mvn build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion}-SNAPSHOT versions:commit
-            # git commit -am "released ${MVN_VERSION}" && git push
-            echo "Succesfully released ${MVN_VERSION}"
+mvn-collect-artifacts-command: &mvn-collect-artifacts-command
+  mvn-collect-artifacts-command: |
+    mkdir -p artifacts/cli artifacts/coverage artifacts/junit artifacts/javadoc
+    cp **/target/*.jar artifacts/
+    cp modules/cli-module/target/*standalone* artifacts/cli/
+    cp -a target/apidocs/. artifacts/javadoc/
+    cp -a modules/jacoco-aggregator-module/target/site/jacoco-aggregate/. artifacts/coverage/
+    cp -a **/target/surefire-reports/. artifacts/junit
 
+mvn-deploy-command: &mvn-deploy-command
+  mvn-deploy-command: mvn -s .circleci/maven-release-settings.xml clean deploy -DdeployAtEnd=true -DperformRelease=true -DskipTests -Dspotbugs.skip=true
+  context: RELEASE_PROFILE_BBOTTEMA
 
 workflows:
   workflow:
     jobs:
-      - build-and-test
-      - approve-deploy-patch-version:
+      - github-maven-deploy/build-and-test:
+          <<: *mvn-build-test-command
+          <<: *mvn-collect-artifacts-command
+          filters:
+            branches:
+              only: master
+
+      - github-maven-deploy/approve-deploy-patch-version:
           type: approval
           requires:
-            - build-and-test
-      - approve-deploy-minor-version:
+            - github-maven-deploy/build-and-test
+      - github-maven-deploy/approve-deploy-minor-version:
           type: approval
           requires:
-            - build-and-test
-      - approve-deploy-major-version:
+            - github-maven-deploy/build-and-test
+      - github-maven-deploy/approve-deploy-major-version:
           type: approval
           requires:
-            - build-and-test
-      - deploy-patch-version:
+            - github-maven-deploy/build-and-test
+
+      - github-maven-deploy/deploy-patch-version:
           requires:
-            - approve-deploy-patch-version
-      - deploy-minor-version:
+            - github-maven-deploy/approve-deploy-patch-version
+          <<: *mvn-deploy-command
+      - github-maven-deploy/deploy-minor-version:
           requires:
-            - approve-deploy-minor-version
-      - deploy-major-version:
+            - github-maven-deploy/approve-deploy-minor-version
+          <<: *mvn-deploy-command
+      - github-maven-deploy/deploy-major-version:
           requires:
-            - approve-deploy-major-version
+            - github-maven-deploy/approve-deploy-major-version
+          <<: *mvn-deploy-command

.gitlab-ci.yml

@@ -7,6 +7,24 @@ gpg --allow-secret-key-import --import <keyring>.gpg
 
 That, or you can install one of the binaries to import the key, from here: https://www.gnupg.org/download/index.html
 
+To import the keyring in a CI/CD environment (CircleCI, Azure Devops, Bamboo, Jenkins etc.), you need to import the keyring
+externally (or us a private Repo). Alternatively you can import the ASCII export of the key configured as a property secret
+so you can ECHO it to a file during the build. Once exposed as file, you can use it to sign:
+
+To generate the ASCII export of a key so you can store it a secret property in your build environment:
+    - gpg --no-default-keyring --armor --secret-keyring ./secring.gpg --keyring ./pubring.gpg --export-secret-key USER > secring.gpg.asc
+    - sed ':a;N;$!ba;s/\n/\\n/g' secring.gpg.asc, OR
+    - base64 encode the text
+
+To be able to have your CI/CD script also commit the new version, you need to add github.com's official host finger print.
+    - https://serverfault.com/a/701637/157338
+    - https://discuss.circleci.com/t/error-sending-to-agent-inappropriate-ioctl-for-device/17465/2
+    - https://medium.com/@Joachim8675309/generating-gpg-key-files-cc447431415a
+    - http://frankiesardo.github.io/posts/2015-04-19-automate-everything-with-circleci.html
+    - https://github.com/toknapp/arweave4s/blob/master/.circleci/config.yml
+    - https://serverfault.com/questions/447028/non-interactive-git-clone-ssh-fingerprint-prompt
+    - https://superuser.com/questions/232373/how-to-tell-git-which-private-key-to-use
+
 To release through CI/CD pipeline in CircleCI
 
  1. update release notes and github readme page and push changes

azure-pipelines.yml

@@ -7,10 +7,11 @@
     <artifactId>maven-master-project</artifactId>
     <packaging>pom</packaging>
     <version>6.0.0.beta-SNAPSHOT.2</version>
- 
+
     <name>Simple Java Mail - Maven master project</name>
+    <description>Simple Java Mail - Maven master project</description>
     <url>http://www.simplejavamail.org/</url>
- 
+
     <properties>
         <java.version>1.7</java.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -328,24 +329,29 @@
                 </property>
             </activation>
             <build>
-                <pluginManagement>
-                    <plugins>
-                        <plugin>
-                            <groupId>org.apache.maven.plugins</groupId>
-                            <artifactId>maven-gpg-plugin</artifactId>
-                            <version>1.5</version>
-                            <executions>
-                                <execution>
-                                    <id>sign-artifacts</id>
-                                    <phase>verify</phase>
-                                    <goals>
-                                        <goal>sign</goal>
-                                    </goals>
-                                </execution>
-                            </executions>
-                        </plugin>
-                    </plugins>
-                </pluginManagement>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-gpg-plugin</artifactId>
+                        <version>1.5</version>
+                        <executions>
+                            <execution>
+                                <id>sign-artifacts</id>
+                                <phase>verify</phase>
+                                <goals>
+                                    <goal>sign</goal>
+                                </goals>
+                                <!-- fixes tty error under linux -->
+                                <configuration>
+                                    <gpgArguments>
+                                        <arg>--pinentry-mode</arg>
+                                        <arg>loopback</arg>
+                                    </gpgArguments>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
             </build>
         </profile>