|
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)_ |
0 commit comments