Merge pull request #68 from xdev-software/update-from-template

Update from template

Author: AB-xdev

.github/workflows/checkBuild.yml

@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        java: [8, 11, 17] 
+        java: [8, 11, 17]
         java-package: [jdk]
         distribution: [temurin]
 
@@ -63,3 +63,4 @@ jobs:
       with:
         name: jars-java-${{ matrix.java }}
         path: target/*.jar
+        if-no-files-found: error

.github/workflows/release.yml

@@ -4,13 +4,17 @@ on:
   push:
     branches: [ master ]
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
-  check_code: # Validates the code (see develop.yml)
+  check_code: # Validates the code (see checkBuild.yml)
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up JDK 8
+    - name: Set up JDK
       uses: actions/setup-java@v3
       with:
         distribution: 'temurin'
@@ -63,7 +67,9 @@ jobs:
     - name: Get version
       id: version
       run: |
-       echo "::set-output name=release::$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)"
+        version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
+        echo "release=$version" >> $GITHUB_OUTPUT
+        echo "releasenumber=${version//[!0-9]/}" >> $GITHUB_OUTPUT
   
     - name: Commit and Push
       run: |
@@ -75,25 +81,23 @@ jobs:
     
     - name: Create Release
       id: create_release
-      uses: actions/create-release@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      uses: shogo82148/actions-create-release@v1
       with:
         tag_name: v${{ steps.version.outputs.release }}
         release_name: v${{ steps.version.outputs.release }}
         commitish: master
         body: |
-          ## Installation [![Maven Central](https://img.shields.io/maven-central/v/com.xdev-software/csapi?versionPrefix=${{ steps.version.outputs.release }})](https://mvnrepository.com/artifact/com.xdev-software/csapi)
+          ## [Changelog](https://github.com/xdev-software/${{ github.event.repository.name }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }})
+          See [Changelog#v${{ steps.version.outputs.release }}](https://github.com/xdev-software/${{ github.event.repository.name }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }}) for more information.
+          ## Installation
           Add the following lines to your pom:
           ```XML
           <dependency>
              <groupId>com.xdev-software</groupId>
-             <artifactId>csapi</artifactId>
+             <artifactId>${{ github.event.repository.name }}</artifactId>
              <version>${{ steps.version.outputs.release }}</version>
           </dependency>
           ```
-        draft: false
-        prerelease: false
 
   publish_central: # Publish the code to central
     runs-on: ubuntu-latest
@@ -107,7 +111,7 @@ jobs:
         git config --global user.name "GitHub Actions"
         git pull
     
-    - name: Set up JDK 8 OSSRH
+    - name: Set up JDK OSSRH
       uses: actions/setup-java@v3
       with: # running setup-java again overwrites the settings.xml
         distribution: 'temurin'
@@ -120,7 +124,7 @@ jobs:
         # Due to https://github.com/actions/setup-java/issues/85 we can only 
         # add ONE server using setup-java...
         overwrite-settings: false
-    
+
       # ... so let's simply copy a predefined settings.xml file into the m2 folder
       # until GH makes it work
     - name: Copy predefined settings into home m2 folder
@@ -150,7 +154,7 @@ jobs:
         git config --global user.name "GitHub Actions"
         git pull
 
-    - name: Set up JDK 8
+    - name: Set up JDK
       uses: actions/setup-java@v3
       with:
         distribution: 'temurin'
@@ -220,7 +224,6 @@ jobs:
     - name: pull-request
       uses: repo-sync/pull-request@v2
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
         destination_branch: "develop"
         pr_title: "Sync back"
         pr_body: "An automated PR to sync changes back"

.github/workflows/test-deploy.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up JDK 8 OSSRH
+    - name: Set up JDK OSSRH
       uses: actions/setup-java@v3
       with: # running setup-java again overwrites the settings.xml
         distribution: 'temurin'
@@ -22,7 +22,7 @@ jobs:
         # Due to https://github.com/actions/setup-java/issues/85 we can only 
         # add ONE server using setup-java...
         overwrite-settings: false
-    
+
       # ... so let's simply copy a predefined settings.xml file into the m2 folder
       # until GH makes it work
     - name: Copy predefined settings into home m2 folder

.github/workflows/update-from-template.yml

@@ -0,0 +1,92 @@
+name: Update from Template
+
+# This workflow keeps the repo up to date with changes from the template repo (REMOTE_URL)
+# It duplicates the REMOTE_BRANCH (into UPDATE_BRANCH) and tries to merge it into the 
+# this repos default branch (which is checked out here)
+# Note that this requires a PAT (Personal Access Token) - at best from a servicing account
+# Also note that you should have at least once merged the template repo into the current repo manually
+# otherwise a "refusing to merge unrelated histories" error might occur.
+
+on:
+  schedule:
+    - cron: '55 2 * * 1'
+  workflow_dispatch:
+
+env:
+  UPDATE_BRANCH: update-from-template
+  REMOTE_URL: https://github.com/xdev-software/xdev-swing-framework-template.git
+  REMOTE_BRANCH: master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # Required because otherwise there are always changes detected when executing diff/rev-list
+          fetch-depth: 0
+          # If no PAT is used the following error occurs on a push:
+          # refusing to allow a GitHub App to create or update workflow `.github/workflows/xxx.yml` without `workflows` permission
+          token: ${{ secrets.UPDATE_FROM_TEMPLATE_PAT }}
+      
+      - name: Init Git
+        run: |
+          git config --global user.email "actions@github.com"
+          git config --global user.name "GitHub Actions"
+
+      - name: Main workflow
+        id: main
+        run: |
+          echo "Adding remote template-repo"
+          git remote add template ${{ env.REMOTE_URL }}
+          
+          echo "Fetching remote template repo"
+          git fetch template
+          
+          echo "Deleting local branch that will contain the updates - if present"
+          git branch -D ${{ env.UPDATE_BRANCH }} || true
+          
+          echo "Checking if the remote template repo has new commits"
+          git rev-list ..template/${{ env.REMOTE_BRANCH }}
+
+          if [ $(git rev-list --count ..template/${{ env.REMOTE_BRANCH }}) -eq 0 ]; then
+            echo "There are no commits new commits on the template repo"
+            
+            echo "Deleting origin branch that contains the updates - if present"
+            git push -f origin --delete ${{ env.UPDATE_BRANCH }} || true
+            
+            echo "abort=1" >> $GITHUB_OUTPUT
+            exit 0
+          fi
+          
+          echo "Found new commits on the template repo"
+          
+          echo "Creating update branch"
+          git branch ${{ env.UPDATE_BRANCH }} template/${{ env.REMOTE_BRANCH }}
+          git branch --unset-upstream ${{ env.UPDATE_BRANCH }}
+          
+          echo "Pushing update branch"
+          git push -f -u origin ${{ env.UPDATE_BRANCH }}
+          
+          echo "Getting current branch"
+          current_branch=$(git branch --show-current)
+          echo "Current branch is $current_branch"
+          echo "current_branch=$current_branch" >> $GITHUB_OUTPUT
+
+          echo "abort=0" >> $GITHUB_OUTPUT
+          
+      - name: pull-request
+        uses: repo-sync/pull-request@v2
+        if: steps.main.outputs.abort == 0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          source_branch: ${{ env.UPDATE_BRANCH }}
+          destination_branch: ${{ steps.main.outputs.current_branch }}
+          pr_title: "Update from template"
+          pr_body: "An automated PR to sync changes from the template into this repo"
+          

.gitignore

@@ -1,7 +1,87 @@
+# Maven
 target/
-bin/
-.settings
-.classpath
-.project
-.checkstyle
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
 dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+# https://github.com/takari/maven-wrapper#usage-without-binary-jar
+.mvn/wrapper/maven-wrapper.jar
+
+
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package/Binary Files don't belong into a git repo
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+*.dll
+*.exe
+*.bin
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+
+# bin / compiled stuff
+target/
+
+
+# JRebel
+**/resources/rebel.xml
+**/resources/rebel-remote.xml
+
+# eclispe stuff for root
+/.settings/
+/.classpath
+/.project
+
+
+# eclispe stuff for modules
+/*/.metadata/
+/*/.apt_generated_tests/
+/*/.settings/
+/*/.classpath
+/*/.project
+/*/RemoteSystemsTempFiles/
+
+#custom
+.flattened-pom.xml
+.tern-project
+
+# == IntelliJ ==
+*.iml
+*.ipr
+
+# Some files are user/installation independent and are used for configuring the IDE
+# See also https://stackoverflow.com/a/35279076
+
+.idea/*
+!.idea/saveactions_settings.xml
+!.idea/checkstyle-idea.xml
+
+!.idea/inspectionProfiles/
+.idea/inspectionProfiles/*
+!.idea/inspectionProfiles/Project_Default.xml
+
+!.idea/codeStyles/
+.idea/codeStyles/*
+!.idea/codeStyles/codeStyleConfig.xml
+!.idea/codeStyles/Project.xml