Skip to content
This repository was archived by the owner on Jan 18, 2024. It is now read-only.

Commit b2efc74

Browse files
committed
Merge remote-tracking branch 'origin/update-from-template' into develop
2 parents ba7c08c + 07b1823 commit b2efc74

9 files changed

+56
-46
lines changed

.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto

.github/dependabot.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ updates:
1919
interval: daily
2020
# Run it at a specific time so that we don't get emails all day long
2121
time: "00:00"
22-
open-pull-requests-limit: 10
22+
open-pull-requests-limit: 10

.github/workflows/checkBuild.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
distribution: [temurin]
2323

2424
steps:
25-
- uses: actions/checkout@v3
25+
- uses: actions/checkout@v4
2626

2727
- name: Set up JDK
2828
uses: actions/setup-java@v3

.github/workflows/release.yml

+14-10
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
check_code: # Validates the code (see checkBuild.yml)
1313
runs-on: ubuntu-latest
1414
steps:
15-
- uses: actions/checkout@v3
15+
- uses: actions/checkout@v4
1616

1717
- name: Set up JDK
1818
uses: actions/setup-java@v3
@@ -48,7 +48,7 @@ jobs:
4848
outputs:
4949
upload_url: ${{ steps.create_draft.outputs.upload_url }}
5050
steps:
51-
- uses: actions/checkout@v3
51+
- uses: actions/checkout@v4
5252

5353
- name: Configure Git
5454
run: |
@@ -97,7 +97,7 @@ jobs:
9797
runs-on: ubuntu-latest
9898
needs: [prepare_release]
9999
steps:
100-
- uses: actions/checkout@v3
100+
- uses: actions/checkout@v4
101101

102102
- name: Init Git and pull
103103
run: |
@@ -128,7 +128,7 @@ jobs:
128128
runs-on: ubuntu-latest
129129
needs: [prepare_release]
130130
steps:
131-
- uses: actions/checkout@v3
131+
- uses: actions/checkout@v4
132132

133133
- name: Init Git and pull
134134
run: |
@@ -180,7 +180,7 @@ jobs:
180180
runs-on: ubuntu-latest
181181
needs: [publish_central]
182182
steps:
183-
- uses: actions/checkout@v3
183+
- uses: actions/checkout@v4
184184

185185
- name: Init Git and pull
186186
run: |
@@ -198,8 +198,12 @@ jobs:
198198
git push origin
199199
200200
- name: pull-request
201-
uses: repo-sync/pull-request@v2
202-
with:
203-
destination_branch: "develop"
204-
pr_title: "Sync back"
205-
pr_body: "An automated PR to sync changes back"
201+
env:
202+
GH_TOKEN: ${{ github.token }}
203+
run: |
204+
gh_pr_up() {
205+
gh pr create "$@" || gh pr edit "$@"
206+
}
207+
gh_pr_up -B "develop" \
208+
--title "Sync back" \
209+
--body "An automated PR to sync changes back"

.github/workflows/test-deploy.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jobs:
77
publish_central: # Publish the code to central
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/checkout@v3
10+
- uses: actions/checkout@v4
1111

1212
- name: Set up JDK OSSRH
1313
uses: actions/setup-java@v3

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

+11-9
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
runs-on: ubuntu-latest
2727

2828
steps:
29-
- uses: actions/checkout@v3
29+
- uses: actions/checkout@v4
3030
with:
3131
# Required because otherwise there are always changes detected when executing diff/rev-list
3232
fetch-depth: 0
@@ -81,12 +81,14 @@ jobs:
8181
echo "abort=0" >> $GITHUB_OUTPUT
8282
8383
- name: pull-request
84-
uses: repo-sync/pull-request@v2
8584
if: steps.main.outputs.abort == 0
86-
with:
87-
github_token: ${{ secrets.GITHUB_TOKEN }}
88-
source_branch: ${{ env.UPDATE_BRANCH }}
89-
destination_branch: ${{ steps.main.outputs.current_branch }}
90-
pr_title: "Update from template"
91-
pr_body: "An automated PR to sync changes from the template into this repo"
92-
85+
env:
86+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
87+
run: |
88+
gh_pr_up() {
89+
gh pr create "$@" || gh pr edit "$@"
90+
}
91+
gh_pr_up -B "${{ steps.main.outputs.current_branch }}" \
92+
-H "${{ env.UPDATE_BRANCH }}" \
93+
--title "Update from template" \
94+
--body "An automated PR to sync changes from the template into this repo"

.idea/checkstyle-idea.xml

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CONTRIBUTING.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11
## Contributing
22

3-
We would absolutely love to get the community involved, and we welcome any form of contributions – comments and
4-
questions on different communication channels, issues and pull request in the repositories, and anything that you build
5-
and share using our components.
3+
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 and anything that you build and share using our components.
64

7-
### Get in touch with the team
5+
### Communication channels
6+
* Communication is primarily done using issues.
7+
* If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
8+
* As a last resort measure or on otherwise important matter you may also [contact us directly](https://xdev.software/en/about-us/contact).
89

9-
Twitter: https://twitter.com/xdevsoftware
10-
<br/>
11-
Mail: opensource@xdev-software.de
10+
### Ways to help
11+
* **Report bugs**<br/>Create an issue or send a pull request
12+
* **Send pull requests**<br/>If you want to contribute code, check out the development instructions below.
13+
* However when contributing new features, please first discuss the change you wish to make via issue with the owners of this repository before making a change. Otherwise your work might be rejected and your effort was pointless.
1214

13-
### Some ways to help:
14-
15-
- **Report bugs**: File issues on GitHub.
16-
- **Send pull requests**: If you want to contribute code, check out the development instructions below.
17-
18-
We encourage you to read
19-
the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing)
20-
also.
15+
We also encourage you to read the [contribution instructions by GitHub](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
2116

2217
## Developing
2318

@@ -31,6 +26,14 @@ You should have the following things installed:
3126
* Maven
3227

3328
### Recommended setup
29+
* Install ``IntelliJ`` (Community Edition is sufficient)
30+
* Install the following plugins:
31+
* [Save Actions](https://plugins.jetbrains.com/plugin/22113) - Provides save actions, like running the formatter or adding ``final`` to fields
32+
* [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
33+
* [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
34+
* Import the project
35+
* Ensure that everything is encoded in ``UTF-8``
36+
* Ensure that the JDK/Java-Version is correct
3437

3538
* Install ``IntelliJ`` (Community Edition is sufficient)
3639
* Install the following plugins:
@@ -54,5 +57,4 @@ Before releasing:
5457
If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes.
5558

5659
When the release is finished do the following:
57-
5860
* Merge the auto-generated PR (with the incremented version number) back into the ``develop``

pom.xml

+5-5
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@
113113
<plugin>
114114
<groupId>com.mycila</groupId>
115115
<artifactId>license-maven-plugin</artifactId>
116-
<version>4.1</version>
116+
<version>4.3</version>
117117
<configuration>
118118
<properties>
119119
<email>${project.organization.url}</email>
@@ -142,7 +142,7 @@
142142
<plugin>
143143
<groupId>org.apache.maven.plugins</groupId>
144144
<artifactId>maven-compiler-plugin</artifactId>
145-
<version>3.10.1</version>
145+
<version>3.11.0</version>
146146
<configuration>
147147
<source>${maven.compiler.source}</source>
148148
<target>${maven.compiler.target}</target>
@@ -154,7 +154,7 @@
154154
<plugin>
155155
<groupId>org.apache.maven.plugins</groupId>
156156
<artifactId>maven-javadoc-plugin</artifactId>
157-
<version>3.4.1</version>
157+
<version>3.6.0</version>
158158
<executions>
159159
<execution>
160160
<id>attach-javadocs</id>
@@ -172,7 +172,7 @@
172172
<plugin>
173173
<groupId>org.apache.maven.plugins</groupId>
174174
<artifactId>maven-source-plugin</artifactId>
175-
<version>3.2.1</version>
175+
<version>3.3.0</version>
176176
<executions>
177177
<execution>
178178
<id>attach-sources</id>
@@ -193,7 +193,7 @@
193193
<plugin>
194194
<groupId>org.apache.maven.plugins</groupId>
195195
<artifactId>maven-gpg-plugin</artifactId>
196-
<version>3.0.1</version>
196+
<version>3.1.0</version>
197197
<executions>
198198
<execution>
199199
<id>sign-artifacts</id>

0 commit comments

Comments
 (0)