Ultimate Maven Repository
The Ultimate Maven Repository Template for your GitHub projects!
Purpose
This is a template repository, used for quickly setting up a GitHub repository with the following features:
- Maven Build Workflow
- Maven Publish Workflow
- Publish to Maven Central Repository
- Publish to GitHub Packages
- Auto Generate Release Notes
- Sponsorships
- Dependabot
- GitHub Pages
- Citations
Step-by-Step Instructions
Included Files
This is the complete list of files included in this template. Each file may need additional attention, or mandatory changes.
Legend | Description |
---|---|
π§ | MUST be edited. |
βοΈ | SHOULD be edited. |
π | SHOULD be reviewed. |
π§ | MAY be reviewed |
ποΈ | MAY be deleted |
Files
/.github
/workflows
maven.yml
π
Defines the GitHub Action check to be run on PRs and merged tomain
.maven-publish.yml
π
Defines the GitHub Action for publishing the Maven Artifact to GitHub Packages & Maven Central Repository.pullRequestAudit.yml
βοΈ/ποΈ
PR Workflow Label checker. Requires:- MAJOR
- MINOR
- PATCH
- bug
- dependencies
- documentation
- feature
- javadocs
- meta
- refactor
- test
CODEOWNERS
βοΈ/ποΈ
Defines owners of files in the repository.dependabot.yml
π
Configures Dependabot.FUNDING.yml
βοΈ/ποΈ
Configuration for GitHub Sponsorships.release.yml
βοΈ/ποΈ
Configuration for Auto-Generated Release Notes based on GitHub Issue Labels.
.mvn
jvm.config
π§
Maven JVM Config file.
.gitattributes
π§
Setslf
as EOF..gitignore
π§
Default.gitignore
provided by GitHub, with.idea
._config.yml
π§
Config for GitHub Pages.CITATION.cff
βοΈ/ποΈ
For citing/referencing the repository.LICENSE
π§
Default Apache 2.0 License.pom.xml
π§
Maven Project file.README.md
π§
This README file.
[!TIP] Most files will have a βTODOβ comment where attention is needed. It is recommended to use an IDE when resolving these comments, as IDEs will highlight these differently.
Generating GPG keys for Uploading
Follow these instructions.