Skip to content

Commit 2176375

Browse files
authored
Initial Setup (#1)
1 parent 89a8687 commit 2176375

File tree

10 files changed

+37
-128
lines changed

10 files changed

+37
-128
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
# Assign ownership of files.
2-
# Example: * @Chrimle
3-
# Explanation: Would assign @Chrimle as owner of all (*) files in the repository.
2+
* @Chrimle

.github/FUNDING.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# These are supported funding model platforms
2-
# TODO: The feature "Sponsorships" MUST be enabled in the Repository Settings to take effect!
32

43
github: Chrimle # Replace with a single GitHub username
54
patreon: # Replace with a single Patreon username

.github/release.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# .github/release.yml
22
# Defines the structure of the auto-generated "Release Notes" when creating a new Release via GitHub.
3-
# TODO: Each "label" corresponds to a GitHub Issue label. Update accordingly.
43

54
changelog:
65
exclude: # PRs labelled with these will be excluded from the Release Notes.

.github/workflows/maven-publish.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,34 @@ jobs:
1717

1818
steps:
1919
- uses: actions/checkout@v4
20-
- name: Set up JDK 17
20+
- name: Set up JDK 25
2121
uses: actions/setup-java@v4
2222
with:
23-
java-version: '17' # TODO: Update accordingly
23+
java-version: '25'
2424
distribution: 'temurin'
2525

2626
- name: Build with Maven
2727
run: mvn -B package --file pom.xml
2828

2929
- name: Publish to GitHub Packages Apache Maven
30-
run: mvn deploy #-Djacoco.skip=true # TODO: Update accordingly, if using Jacoco.
30+
run: mvn deploy #-Djacoco.skip=true
3131
env:
3232
GITHUB_TOKEN: ${{ github.token }}
3333

3434
- name: Set up Apache Maven Central
3535
uses: actions/setup-java@v4
3636
with: # running setup-java again overwrites the settings.xml
3737
distribution: 'temurin'
38-
java-version: '17' # TODO: Update accordingly
38+
java-version: '25'
3939
server-id: central
4040
server-username: MAVEN_USERNAME # env variable for username in deploy
4141
server-password: MAVEN_CENTRAL_TOKEN # env variable for token in deploy
42-
gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import. TODO: Set this in GitHub Secrets!
42+
gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import.
4343
gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
4444

4545
- name: Publish to Apache Maven Central
46-
run: mvn -P deploy-to-maven-central deploy #-Djacoco.skip=true # TODO: Update accordingly, if using Jacoco.
46+
run: mvn -P deploy-to-maven-central deploy #-Djacoco.skip=true
4747
env:
48-
MAVEN_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }} # TODO: Set this in GitHub Secrets!
49-
MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_PASSWORD }} # TODO: Set this in GitHub Secrets!
50-
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }} # TODO: Set this in GitHub Secrets!
48+
MAVEN_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
49+
MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
50+
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}

.github/workflows/maven.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
- name: Set up JDK
2727
uses: actions/setup-java@v4
2828
with:
29-
java-version: '17' # TODO: Update accordingly. See "strategy matrix" for testing multiple versions.
29+
java-version: '25'
3030
distribution: 'temurin'
3131
cache: maven
3232
- name: Maven Build

.github/workflows/pullRequestAudit.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
with:
2424
script: |
2525
const categoriesRequiringSemanticVersion = ['feature', 'bug', 'javadocs'];
26-
const requiredCategories = ['feature', 'bug', 'documentation', 'test', 'dependencies', 'meta', 'javadocs', 'refactor'];
26+
const requiredCategories = ['feature', 'bug', 'documentation', 'tests', 'dependencies', 'meta', 'javadocs', 'refactor'];
2727
const semanticVersions = ['MAJOR', 'MINOR', 'PATCH'];
2828
2929
const labels = context.payload.pull_request.labels;

CITATION.cff

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ authors:
44
- family-names: "Molin"
55
given-names: "Christopher"
66
orcid: "https://orcid.org/0009-0002-1005-3942"
7-
title: "Ultimate Maven Repository"
8-
version: 0.2.0
9-
date-released: 2025-07-22
10-
url: "https://github.com/Chrimle/Ultimate-Maven-Repository"
7+
title: "Compact Java CLI"
8+
version: 0.0.0
9+
date-released: 2025-10-07
10+
url: "https://github.com/Chrimle/Compact-Java-CLI"

README.md

Lines changed: 2 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,2 @@
1-
# Ultimate Maven Repository
2-
3-
*The Ultimate Maven Repository Template for your GitHub projects!*
4-
5-
## Purpose
6-
This is a *template* repository, used for quickly setting up a GitHub repository with the following features:
7-
- Maven Build Workflow
8-
- Maven Publish Workflow
9-
- Publish to Maven Central Repository
10-
- Publish to GitHub Packages
11-
- Auto Generate Release Notes
12-
- Sponsorships
13-
- Dependabot
14-
- GitHub Pages
15-
- Citations
16-
17-
# Step-by-Step Instructions
18-
19-
## Included Files
20-
21-
This is the complete list of files included in this template. Each file may need additional attention, or mandatory changes.
22-
23-
| Legend | Description |
24-
|:------:|-------------------------|
25-
| 🔧 | **MUST** be edited. |
26-
| ✏️ | **SHOULD** be edited. |
27-
| 👀 | **SHOULD** be reviewed. |
28-
| 🧐 | **MAY** be reviewed |
29-
| 🗑️ | **MAY** be deleted |
30-
31-
### Files
32-
33-
- [`/.github`](.github)<br/><br/>
34-
- [`/workflows`](.github/workflows)<br/><br/>
35-
- [`maven.yml`](.github/workflows/maven.yml) 👀 <br/>
36-
Defines the GitHub Action check to be run on PRs and merged to `main`.<br/><br/>
37-
- [`maven-publish.yml`](.github/workflows/maven-publish.yml) 👀 <br/>
38-
Defines the GitHub Action for publishing the Maven Artifact to GitHub Packages & Maven Central Repository.<br/><br/>
39-
- [`pullRequestAudit.yml`](.github/workflows/pullRequestAudit.yml) ✏️/🗑️ <br/>
40-
PR Workflow Label checker. Requires:
41-
- MAJOR
42-
- MINOR
43-
- PATCH
44-
- bug
45-
- dependencies
46-
- documentation
47-
- feature
48-
- javadocs
49-
- meta
50-
- refactor
51-
- test
52-
<br/><br/>
53-
- [`CODEOWNERS`](.github/CODEOWNERS) ✏️/🗑️ <br/>
54-
Defines *owners* of files in the repository.<br/><br/>
55-
- [`dependabot.yml`](.github/dependabot.yml) 👀 <br/>
56-
Configures *Dependabot*.<br/><br/>
57-
- [`FUNDING.yml`](.github/FUNDING.yml) ✏️/🗑️ <br/>
58-
Configuration for *GitHub Sponsorships*.<br/><br/>
59-
- [`release.yml`](.github/release.yml) ✏️/🗑️ <br/>
60-
Configuration for Auto-Generated Release Notes based on *GitHub Issue Labels*.<br/><br/>
61-
- [`.mvn`](.mvn)
62-
- [`jvm.config`](.mvn/jvm.config) 🧐 <br/>
63-
Maven JVM Config file.<br/><br/>
64-
- [`.gitattributes`](.gitattributes) 🧐 <br/>
65-
Sets `lf` as EOF.<br/><br/>
66-
- [`.gitignore`](.gitignore) 🧐 <br/>
67-
Default `.gitignore` provided by GitHub, with `.idea`.<br/><br/>
68-
- [`_config.yml`](_config.yml) 🔧 <br/>
69-
Config for *GitHub Pages*.<br/><br/>
70-
- [`CITATION.cff`](CITATION.cff) ✏️/🗑️ <br/>
71-
For citing/referencing the repository.<br/><br/>
72-
- [`LICENSE`](LICENSE) 🧐 <br/>
73-
Default *Apache 2.0 License*.<br/><br/>
74-
- [`pom.xml`](pom.xml) 🔧 <br/>
75-
Maven Project file.<br/><br/>
76-
- [`README.md`](README.md) 🔧 <br/>
77-
This README file.<br/><br/>
78-
79-
> [!TIP]
80-
> Most files will have a "TODO" comment where attention is needed. It is recommended to use an IDE when resolving
81-
> these comments, as IDEs will highlight these differently.
82-
83-
## Generating GPG keys for Uploading
84-
Follow [these](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) instructions.
1+
# Compact Java CLI
2+
_A compact Java CLI library, utilizing the latest and greatest from JDK25 (JEP 512)_

_config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
remote_theme: pages-themes/cayman@v0.2.0 # TODO: Update with another theme if desired
1+
remote_theme: pages-themes/cayman@v0.2.0
22

3-
# TODO: Update the following with the repository details!
4-
title: Ultimate Maven Repository
5-
description: The Ultimate Maven Repository Template for your GitHub projects!
3+
4+
title: Compact Java CLI
5+
description: A compact Java CLI library, utilizing the latest and greatest from JDK25 (JEP 512)

pom.xml

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,14 @@
77
<!-- === Project Coordinates === -->
88
<!-- TODO: Update accordingly -->
99
<groupId>io.github.chrimle</groupId>
10-
<artifactId>ultimate-maven-repository</artifactId>
11-
<version>0.2.0</version>
10+
<artifactId>compact-java-cli</artifactId>
11+
<version>0.0.0</version>
1212
<packaging>jar</packaging>
1313

1414
<!-- === Project Metadata === -->
15-
<!-- TODO: Update accordingly -->
16-
<name>Ultimate Maven Repository</name>
17-
<description>The Ultimate Maven Repository Template for your GitHub projects!</description>
18-
<url>https://chrimle.github.io/Ultimate-Maven-Repository</url>
15+
<name>Compact Java CLI</name>
16+
<description>A compact Java CLI library, utilizing the latest and greatest from JDK25 (JEP 512)</description>
17+
<url>https://chrimle.github.io/Compact-Java-CLI</url>
1918
<inceptionYear>2025</inceptionYear>
2019

2120
<licenses>
@@ -27,13 +26,11 @@
2726
</licenses>
2827

2928
<organization>
30-
<!-- TODO: Update accordingly -->
31-
<name>Ultimate Maven Repository</name>
32-
<url>https://chrimle.github.io/Ultimate-Maven-Repository/</url>
29+
<name>Compact Java CLI</name>
30+
<url>https://chrimle.github.io/Compact-Java-CLI/</url>
3331
</organization>
3432

3533
<developers>
36-
<!-- TODO: Update accordingly -->
3734
<developer>
3835
<id>Chrimle</id>
3936
<name>Christopher Molin</name>
@@ -46,23 +43,21 @@
4643
</developers>
4744

4845
<scm>
49-
<!-- TODO: Update Accordingly-->
50-
<url>http://github.com/chrimle/ultimate-maven-repository/tree/main</url>
51-
<connection>scm:git:git://github.com/chrimle/ultimate-maven-repository.git</connection>
52-
<developerConnection>scm:git:ssh://github.com:chrimle/ultimate-maven-repository.git</developerConnection>
46+
<url>http://github.com/chrimle/compact-java-cli/tree/main</url>
47+
<connection>scm:git:git://github.com/chrimle/compact-java-cli.git</connection>
48+
<developerConnection>scm:git:ssh://github.com:chrimle/compact-java-cli.git</developerConnection>
5349
</scm>
5450

5551
<distributionManagement>
56-
<!-- TODO: Update Accordingly -->
5752
<repository>
5853
<id>github</id>
5954
<name>GitHub Chrimle Apache Maven Packages</name>
60-
<url>https://maven.pkg.github.com/chrimle/ultimate-maven-repository</url>
55+
<url>https://maven.pkg.github.com/chrimle/compact-java-cli</url>
6156
</repository>
6257
<snapshotRepository>
6358
<id>github</id>
6459
<name>GitHub Chrimle Apache Maven Snapshot Packages</name>
65-
<url>https://maven.pkg.github.com/chrimle/ultimate-maven-repository</url>
60+
<url>https://maven.pkg.github.com/chrimle/compact-java-cli</url>
6661
</snapshotRepository>
6762
</distributionManagement>
6863

@@ -71,10 +66,9 @@
7166
<!-- === Meta Properties === -->
7267
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
7368
<!-- === Maven Compiler === -->
74-
<!-- TODO: Update accordingly -->
75-
<maven.compiler.release>17</maven.compiler.release>
76-
<maven.compiler.source>17</maven.compiler.source>
77-
<maven.compiler.target>17</maven.compiler.target>
69+
<maven.compiler.release>25</maven.compiler.release>
70+
<maven.compiler.source>25</maven.compiler.source>
71+
<maven.compiler.target>25</maven.compiler.target>
7872
<!-- === Spotless === -->
7973
<spotless.check.skip>false</spotless.check.skip>
8074
<spotless-maven-plugin.version>3.0.0</spotless-maven-plugin.version>

0 commit comments

Comments
 (0)