Automate release with JReleaser

Add JReleaser for automating the release and add a step for automating the publishing of the website

.github/scripts/update-website.sh

@@ -0,0 +1,76 @@
+#!/bin/bash
+#
+# Copyright MapStruct Authors.
+#
+# Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+#
+
+# env vars:
+# VERSION
+# GH_BOT_EMAIL
+
+# This script has been inspired by the JReleaser update-website.sh (https://github.com/jreleaser/jreleaser/blob/main/.github/scripts/update-website.sh)
+set -e
+
+function computePlainVersion() {
+ echo $1 | sed 's/\([[:digit:]]*\)\.\([[:digit:]]*\)\.\([[:digit:]]*\).*/\1.\2.\3/'
+}
+
+function computeMajorMinorVersion() {
+ echo $1 | sed 's/\([[:digit:]]*\)\.\([[:digit:]]*\).*/\1.\2/'
+}
+
+function isStable() {
+ local PLAIN_VERSION=$(computePlainVersion $1)
+ if [ "${PLAIN_VERSION}" == "$1" ]; then
+ echo "yes"
+ else
+ echo "no"
+ fi
+}
+
+STABLE=$(isStable $VERSION)
+MAJOR_MINOR_VERSION=$(computeMajorMinorVersion $VERSION)
+
+DEV_VERSION=`grep devVersion config.toml | sed 's/.*"\(.*\)"/\1/'`
+MAJOR_MINOR_DEV_VERSION=$(computeMajorMinorVersion $DEV_VERSION)
+STABLE_VERSION=`grep stableVersion config.toml | sed 's/.*"\(.*\)"/\1/'`
+MAJOR_MINOR_STABLE_VERSION=$(computeMajorMinorVersion $STABLE_VERSION)
+
+echo "📝 Updating versions"
+sed -i '' -e "s/^devVersion = \"\(.*\)\"/devVersion = \"${VERSION}\"/g" config.toml
+
+if [ "${STABLE}" == "yes" ]; then
+ sed -i '' -e "s/^stableVersion = \"\(.*\)\"/stableVersion = \"${VERSION}\"/g" config.toml
+ if [ "${MAJOR_MINOR_STABLE_VERSION}" != ${MAJOR_MINOR_VERSION} ]; then
+ echo "📝 Updating new stable version"
+ # This means that we have a new stable version and we need to change the order of the releases.
+ sed -i '' -e "s/^order = \(.*\)/order = 500/g" data/releases/${MAJOR_MINOR_VERSION}.toml
+ NEXT_STABLE_ORDER=$((`ls -1 data/releases | wc -l` - 2))
+ sed -i '' -e "s/^order = \(.*\)/order = ${NEXT_STABLE_ORDER}/g" data/releases/${MAJOR_MINOR_STABLE_VERSION}.toml
+ git add data/releases/${MAJOR_MINOR_STABLE_VERSION}.toml
+ fi
+elif [ "${MAJOR_MINOR_DEV_VERSION}" != "${MAJOR_MINOR_VERSION}" ]; then
+ echo "📝 Updating new dev version"
+ # This means that we are updating for a new dev version, but the last dev version is not the one that we are doing.
+ # Therefore, we need to update add the new data configuration
+ cp data/releases/${MAJOR_MINOR_DEV_VERSION}.toml data/releases/${MAJOR_MINOR_VERSION}.toml
+ sed -i '' -e "s/^order = \(.*\)/order = 1000/g" data/releases/${MAJOR_MINOR_VERSION}.toml
+fi
+
+sed -i '' -e "s/^name = \"\(.*\)\"/name = \"${VERSION}\"/g" data/releases/${MAJOR_MINOR_VERSION}.toml
+sed -i '' -e "s/^releaseDate = \(.*\)/releaseDate = $(date +%F)/g" data/releases/${MAJOR_MINOR_VERSION}.toml
+git add data/releases/${MAJOR_MINOR_VERSION}.toml
+git add config.toml
+
+echo "📝 Updating distribution resources"
+tar -xf tmp/mapstruct-${VERSION}-dist.tar.gz --directory tmp
+rm -rf static/documentation/${MAJOR_MINOR_VERSION}
+cp -R tmp/mapstruct-${VERSION}/docs static/documentation/${MAJOR_MINOR_VERSION}
+mv static/documentation/${MAJOR_MINOR_VERSION}/reference/html/mapstruct-reference-guide.html static/documentation/${MAJOR_MINOR_VERSION}/reference/html/index.html
+git add static/documentation/${MAJOR_MINOR_VERSION}
+
+git config --global user.email "${GH_BOT_EMAIL}"
+git config --global user.name "GitHub Action"
+git commit -a -m "Releasing version ${VERSION}"
+git push

.github/workflows/release.yml

@@ -0,0 +1,123 @@
+name: Release
+
+on:
+ workflow_dispatch:
+ inputs:
+ version:
+ description: 'Release version'
+ required: true
+ next:
+ description: 'Next version'
+ required: false
+
+env:
+ JAVA_VERSION: '11'
+ JAVA_DISTRO: 'zulu'
+
+jobs:
+ release:
+ # This job has been inspired by the moditect release (https://github.com/moditect/moditect/blob/main/.github/workflows/release.yml)
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: Setup Java
+ uses: actions/setup-java@v4
+ with:
+ java-version: ${{ vars.JAVA_VERSION }}
+ distribution: ${{ vars.JAVA_DISTRO }}
+ cache: maven
+
+ - name: Set release version
+ id: version
+ run: |
+ RELEASE_VERSION=${{ github.event.inputs.version }}
+ NEXT_VERSION=${{ github.event.inputs.next }}
+ PLAIN_VERSION=`echo ${RELEASE_VERSION} | awk 'match($0, /^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)/) { print substr($0, RSTART, RLENGTH); }'`
+ COMPUTED_NEXT_VERSION="${PLAIN_VERSION}-SNAPSHOT"
+ if [ -z $NEXT_VERSION ]
+ then
+ NEXT_VERSION=$COMPUTED_NEXT_VERSION
+ fi
+ ./mvnw -ntp -B versions:set versions:commit -DnewVersion=$RELEASE_VERSION -pl :mapstruct-parent -DgenerateBackupPoms=false
+ git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+ git config --global user.name "GitHub Action"
+ git commit -a -m "Releasing version $RELEASE_VERSION"
+ git push
+ echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV
+ echo "NEXT_VERSION=$NEXT_VERSION" >> $GITHUB_ENV
+ echo "PLAIN_VERSION=$PLAIN_VERSION" >> $GITHUB_ENV
+
+ - name: Stage
+ run: |
+ export GPG_TTY=$(tty)
+ ./mvnw -ntp -B --file pom.xml \
+ -Dmaven.site.skip=true -Drelease=true -Ppublication,stage
+
+ - name: Release
+ env:
+ JRELEASER_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ JRELEASER_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
+ JRELEASER_GPG_PUBLIC_KEY: ${{ secrets.GPG_PUBLIC_KEY }}
+ JRELEASER_GPG_SECRET_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
+ JRELEASER_NEXUS2_MAVEN_CENTRAL_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+ JRELEASER_NEXUS2_MAVEN_CENTRAL_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+ run: |
+ ./mvnw -ntp -B --file pom.xml -pl :mapstruct-parent -Pjreleaser jreleaser:release
+
+ - name: JReleaser output
+ if: always()
+ uses: actions/upload-artifact@v4
+ with:
+ name: jreleaser-release
+ path: |
+ parent/target/jreleaser/trace.log
+ parent/target/jreleaser/output.properties
+
+ - name: Set next version
+ run: |
+ ./mvnw -ntp -B versions:set versions:commit -DnewVersion=${{ env.NEXT_VERSION }} -pl :mapstruct-parent -DgenerateBackupPoms=false
+ sed -i -e "s@project.build.outputTimestamp>.*</project.build.outputTimestamp@project.build.outputTimestamp>\${git.commit.author.time}</project.build.outputTimestamp@g" parent/pom.xml
+ git config --global user.email "${{ vars.GH_BOT_EMAIL }}"
+ git config --global user.name "GitHub Action"
+ git commit -a -m "Next version ${{ env.NEXT_VERSION }}"
+ git push
+
+ update-website:
+ # This job has been inspired by the JReleaser update-website job (https://github.com/jreleaser/jreleaser/blob/main/.github/workflows/release.yml)
+ name: Update Website
+ needs: [release]
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ with:
+ repository: mapstruct/mapstruct.org
+ ref: main
+ fetch-depth: 0
+ token: ${{ secrets.GIT_WEBSITE_ACCESS_TOKEN }}
+
+ - name: Setup Java
+ uses: actions/setup-java@v4
+ with:
+ java-version: ${{ vars.JAVA_VERSION }}
+ distribution: ${{ vars.JAVA_DISTRO }}
+
+ - name: Download assets
+ shell: bash
+ run: |
+ curl -sL https://raw.githubusercontent.com/mapstruct/mapstruct/main/.github/scripts/update-website.sh --output update-website.sh --create-dirs --output-dir tmp
+ curl -sL "https://github.com/mapstruct/mapstruct/releases/download/${VERSION}/mapstruct-${VERSION}-dist.tar.gz" --output mapstruct-${VERSION}-dist.tar.gz --create-dirs --output-dir tmp
+ env:
+ VERSION: ${{ github.event.inputs.version }}
+
+ - name: Commit
+ shell: bash
+ env:
+ VERSION: ${{ github.event.inputs.version }}
+ GH_BOT_EMAIL: ${{ vars.GH_BOT_EMAIL }}
+ run: |
+ chmod +x update-website.sh
+ ./update-website.sh

NEXT_RELEASE_CHANGELOG.md

@@ -0,0 +1,29 @@
+### Features
+
+* Support conditional mapping for source parameters (#2610, #3459, #3270)
+* Add `@SourcePropertyName` to handle a property name of the source object (#3323) - Currently only applicable for `@Condition` methods
+
+### Enhancements
+
+* Improve error message for mapping to `target = "."` using expression (#3485)
+* Improve error messages for auto generated mappings (#2788)
+* Remove unnecessary casts to long (#3400)
+
+### Bugs
+
+* `@Condition` cannot be used only with `@Context` parameters (#3561)
+* `@Condition` treated as ambiguous mapping for methods returning Boolean/boolean (#3565)
+* Subclass mapping warns about unmapped property that is mapped in referenced mapper (#3360)
+* Interface inherited build method is not found (#3463)
+* Bean with getter returning Stream is treating the Stream as an alternative setter (#3462)
+* Using `Mapping#expression` and `Mapping#conditionalQualifiedBy(Name)` should lead to compile error (#3413)
+* Defined mappings for subclass mappings with runtime exception subclass exhaustive strategy not working if result type is abstract class (#3331)
+
+### Documentation
+
+* Clarify that `Mapping#ignoreByDefault` is inherited in nested mappings in documentation (#3577)
+
+### Build
+
+* Improve tests to show that Lombok `@SuperBuilder` is supported (#3524)
+* Add Java 21 CI matrix build (#3473)