ci: setup CI/CD pipelines, versioning and agent guidelines

2026-05-11 14:19:54 +02:00
parent f310646868
commit 945633e5bd
22 changed files with 544 additions and 15 deletions
@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+      - 'feature/**'
+      - 'fix/**'
+      - 'hotfix/**'
+    tags-ignore:
+      - 'v*'
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build & Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Temurin 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+          cache: maven
+          server-id: Personal
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_PASSWORD
+
+      - name: Build and test
+        run: mvn -B --settings .github/settings.xml clean verify
+        env:
+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
+
+      - name: Publish test results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results
+          path: '**/target/surefire-reports/*.xml'
+          retention-days: 7
@@ -0,0 +1,69 @@
+name: Prepare Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Release version (e.g. 2.0.0)'
+        required: true
+        type: string
+      next_version:
+        description: 'Next development version without -SNAPSHOT (e.g. 2.1.0)'
+        required: true
+        type: string
+
+jobs:
+  prepare:
+    name: Bump, Tag & Push
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      - name: Set up Temurin 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+          cache: maven
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Set release version
+        run: mvn -B --settings .github/settings.xml versions:set -DnewVersion=${{ inputs.version }}
+        env:
+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
+
+      - name: Commit release version
+        run: |
+          git add -A
+          git commit -m "chore(release): ${{ inputs.version }}"
+
+      - name: Tag release
+        run: git tag v${{ inputs.version }}
+
+      - name: Set next snapshot version
+        run: mvn -B --settings .github/settings.xml versions:set -DnewVersion=${{ inputs.next_version }}-SNAPSHOT
+        env:
+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
+
+      - name: Commit next snapshot version
+        run: |
+          git add -A
+          git commit -m "chore(release): prepare ${{ inputs.next_version }}-SNAPSHOT"
+
+      - name: Push commits and tag
+        run: |
+          git push origin master
+          git push origin v${{ inputs.version }}
@@ -0,0 +1,136 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    name: Build, Sign, Deploy & Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Extract version from tag
+        id: version
+        run: echo "VERSION=${GITHUB_REF_NAME#v}" >> $GITHUB_OUTPUT
+
+      - name: Set up Temurin 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+          cache: maven
+
+      - name: Import GPG key
+        run: |
+          echo "${{ secrets.GPG_PRIVATE_KEY }}" | gpg --batch --import
+          GPG_KEY_ID=$(gpg --list-secret-keys --with-colons | grep '^sec' | cut -d: -f5 | head -1)
+          echo "GPG_KEY_ID=$GPG_KEY_ID" >> $GITHUB_ENV
+
+      - name: Build, sign and deploy to releases
+        run: |
+          mvn -B --settings .github/settings.xml \
+            -DperformRelease=true \
+            -Dgpg.keyname=$GPG_KEY_ID \
+            clean deploy
+        env:
+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
+
+      - name: Generate aggregated JavaDoc
+        run: |
+          mvn -B --settings .github/settings.xml \
+            -pl flash,flash-extensions -am \
+            javadoc:aggregate -DskipTests
+        env:
+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
+
+      - name: Checkout gh-pages
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+          path: gh-pages-out
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Copy JavaDoc to versioned folder
+        run: |
+          VERSION=${{ steps.version.outputs.VERSION }}
+          mkdir -p gh-pages-out/javadoc/$VERSION
+          cp -r target/reports/apidocs/. gh-pages-out/javadoc/$VERSION/
+          rm -rf gh-pages-out/latest
+          mkdir -p gh-pages-out/latest
+          cp -r target/reports/apidocs/. gh-pages-out/latest/
+
+      - name: Regenerate index.html
+        run: |
+          cd gh-pages-out
+          python3 - <<'EOF'
+          import os, re
+
+          versions = sorted(
+              [d for d in os.listdir("javadoc") if os.path.isdir(f"javadoc/{d}")],
+              key=lambda v: [int(x) for x in re.sub(r'[^0-9.]', '', v).split('.') if x],
+              reverse=True
+          )
+
+          rows = "\n".join(
+              f'      <li><a href="javadoc/{v}/index.html">{v}</a></li>'
+              for v in versions
+          )
+
+          html = f"""<!DOCTYPE html>
+          <html lang="en">
+          <head>
+            <meta charset="UTF-8">
+            <title>Flash JavaDoc</title>
+            <style>
+              body {{ font-family: sans-serif; max-width: 600px; margin: 4rem auto; }}
+              h1 {{ font-size: 1.6rem; }}
+              ul {{ line-height: 2; }}
+              a {{ color: #0070f3; text-decoration: none; }}
+              a:hover {{ text-decoration: underline; }}
+            </style>
+          </head>
+          <body>
+            <h1>Flash — JavaDoc</h1>
+            <p><a href="latest/index.html">&#8594; Latest</a></p>
+            <h2>All versions</h2>
+            <ul>
+          {rows}
+            </ul>
+          </body>
+          </html>"""
+
+          with open("index.html", "w") as f:
+              f.write(html)
+          print(f"index.html generated with {len(versions)} versions: {versions}")
+          EOF
+
+      - name: Push gh-pages
+        run: |
+          cd gh-pages-out
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add -A
+          git diff --cached --quiet || git commit -m "docs(javadoc): release ${{ steps.version.outputs.VERSION }}"
+          git push origin gh-pages
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: v${{ steps.version.outputs.VERSION }}
+          name: v${{ steps.version.outputs.VERSION }}
+          generate_release_notes: true
+          draft: false
+          prerelease: false
@@ -0,0 +1,30 @@
+name: Publish Snapshot
+
+on:
+  push:
+    branches:
+      - master
+    tags-ignore:
+      - 'v*'
+
+jobs:
+  snapshot:
+    name: Deploy Snapshot
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Temurin 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+          cache: maven
+
+      - name: Deploy snapshot
+        run: mvn -B --settings .github/settings.xml clean deploy -DskipTests
+        env:
+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}