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
• PR Labelling Audit Workflow
• Auto Generate Release Notes
• Sponsorships
• Dependabot
• GitHub Pages
• Citations
• Code of Conduct
• Contribution Guidelines
• Security Policy

This project also showcases the many features of GitHub, which are not all mandatory. Below, is a summary of all provided files.

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 to main.
      
      
    • 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
        
        
  • CODE_OF_CONDUCT.md ✏️/🗑️
    Defines the Code of Conduct of the project.
    
    
  • CODEOWNERS ✏️/🗑️
    Defines owners of files in the repository.
    
    
  • CONTRIBUTING.md ✏️/🗑️
    Defines the Contributing Guidelines of the project.
    
    
  • dependabot.yml 👀
    Configures Dependabot.
    
    
  • FUNDING.yml ✏️/🗑️
    Configuration for GitHub Sponsorships.
    
    
  • release.yml ✏️/🗑️
    Configuration for Auto-Generated Release Notes based on GitHub Issue Labels.
    
    
  • SECURITY.md ✏️/🗑️
    Defines the Security Policy of the project.
    
    
• .mvn
  • jvm.config 🧐
    Maven JVM Config file.
    
    
• .gitattributes 🧐
  Sets lf 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.