Maintain repository (#287)

Cleaning up workflows, adding new ones, and maintaining the repository documentation


Co-authored-by: Steffengreiner <Steffen.Greiner@gmx.de>
Co-authored-by: Tobias Koch <KochTobi@users.noreply.github.com>

Author: 3 people

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @qbicsoftware/itss

.github/pr-labels.yml

@@ -0,0 +1,3 @@
+feature: ['feature/*', 'feat/*']
+fix: ['fix/*', 'hotfix']
+chore: ['chore/*', 'documentation/*', 'docs/*', 'ci/*', 'refactor/*']

.github/release.yml

@@ -0,0 +1,20 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - JohnnyQ5
+      - github-actions
+  categories:
+    - title: New Features 🚀
+      labels:
+        - feature
+    - title: Bugfixes 🪲
+      labels:
+        - fix
+    - title: Documentation & CI 🪂
+      labels:
+        - chore
+    - title: Others 🧃
+      labels:
+        - "*"

.github/workflows/build_package.yml

@@ -12,6 +12,13 @@ jobs:
         uses: actions/setup-java@v1
         with:
           java-version: 1.8
+      - name: Load local Maven repository cache
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
 
       - name: Run mvn package
         run: mvn -B package --file pom.xml

.github/workflows/changelog-update.yml

@@ -0,0 +1,89 @@
+name: Create Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      versionTag:
+        description: 'Version Tag (semantic version)'
+        required: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+          settings-path: ${{ github.workspace }}
+
+      - name: Load local Maven repository cache
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+      - name: Set up git
+        run: |
+          git config --global user.email "support@qbic.zendesk.com"
+          git config --global user.name "JohnnyQ5"
+      - name: Set version in Maven project
+        run:  mvn versions:set -DnewVersion=${{ github.event.inputs.versionTag }}
+
+      - name: Build with Maven
+        run: mvn -B package --file pom.xml
+
+      - name: Create Release Notes
+        if: ${{ !startsWith(github.ref, 'refs/tags/')
+          && !( contains(github.event.inputs.versionTag, 'alpha')
+          || contains(github.event.inputs.versionTag, 'beta')
+          || contains(github.event.inputs.versionTag, 'rc')) }}
+        uses: actions/github-script@v4.0.2
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            await github.request(`POST /repos/${{ github.repository }}/releases`, {
+              tag_name: "${{ github.event.inputs.versionTag }}",
+              generate_release_notes: true
+            });
+      - name: Create Pre-Release Notes
+        if: ${{ !startsWith(github.ref, 'refs/tags/')
+          && ( contains(github.event.inputs.versionTag, 'alpha')
+          || contains(github.event.inputs.versionTag, 'beta')
+          || contains(github.event.inputs.versionTag, 'rc')) }}
+        uses: actions/github-script@v4.0.2
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            await github.request(`POST /repos/${{ github.repository }}/releases`, {
+              tag_name: "${{ github.event.inputs.versionTag }}",
+              generate_release_notes: true,
+              prerelease: true
+            });
+      - name: Publish artefact to QBiC Nexus Repository
+        run: mvn --quiet --settings $GITHUB_WORKSPACE/.github.settings.xml deploy
+        env:
+          MAVEN_REPO_USERNAME: ${{ secrets.NEXUS_USERNAME }}
+          MAVEN_REPO_PASSWORD: ${{ secrets.NEXUS_PASSWORD }}
+
+      - name: Switch to new branch
+        run: git checkout -b release/set-version-to-${{ github.event.inputs.versionTag }}
+
+      - name: Checkin commit
+        run: git commit . -m 'Set version to ${{ github.event.inputs.versionTag }}'
+
+      - name: Set remote branch
+        run: git push --set-upstream origin release/set-version-to-${{ github.event.inputs.versionTag }}
+
+      - name: Open PR with version bump
+        uses: actions/github-script@v4.0.2
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            await github.request(`POST /repos/${{ github.repository }}/pulls`, {
+              title: 'Update version to ${{ github.event.inputs.versionTag }}',
+              head: 'release/set-version-to-${{ github.event.inputs.versionTag }}',
+              base: 'main'
+            });

.github/workflows/create-release.yml

@@ -0,0 +1,15 @@
+name: Label Pull Requests
+
+on:
+  pull_request:
+    types: [ opened, edited ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: TimonVS/pr-labeler-action@v3
+        with:
+          configuration-path: .github/pr-labels.yml # optional, .github/pr-labeler.yml is the default value
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}