Merge pull request #12 from xdev-software/rework

Rework

Author: AB-xdev

.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,11 +1,87 @@
+# Maven
 target/
-bin/
+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
 
-# IDEA
-.idea/
+
+# 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
 
-# Eclispe
-.settings
-.classpath
-.project
+!.idea/codeStyles/
+.idea/codeStyles/*
+!.idea/codeStyles/codeStyleConfig.xml
+!.idea/codeStyles/Project.xml

.idea/checkstyle-idea.xml

@@ -0,0 +1,45 @@
+## Contributing
+
+We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request in the repositories, and anything that you build and share using our components.
+
+### Get in touch with the team
+
+Twitter: https://twitter.com/xdevsoftware 
+<br/>
+Mail: opensource@xdev-software.de
+
+### Some ways to help:
+
+- **Report bugs**: File issues on GitHub.
+- **Send pull requests**: If you want to contribute code, check out the development instructions below.
+
+We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also.
+
+## Developing
+
+### Software Requirements
+You should have the following things installed:
+* Git
+* Java 8, 11 or 17 - should be as unmodified as possible (Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/))
+* Maven
+
+### Recommended setup
+* Install ``IntelliJ`` (Community Edition is sufficient)
+  * Install the following plugins:
+    * [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running the formatter or adding ``final`` to fields
+    * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
+    * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
+  * Import the project
+  * Ensure that everything is encoded in ``UTF-8``
+  * Ensure that the JDK/Java-Version is correct
+
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/xdev-swing-framework-template/release.yml?branch=master)](https://github.com/xdev-software/xdev-swing-framework-template/actions/workflows/release.yml)
+
+Before releasing:
+* Consider doing a [test-deployment](https://github.com/xdev-software/xdev-swing-framework-template/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Check the [changelog](CHANGELOG.md)
+
+If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes.
+
+When the release is finished do the following:
+* Merge the auto-generated PR (with the incremented version number) back into the ``develop``