Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/florianmichael/baseproject
Gradle template project with jar signing, publishing to maven central and GitHub workflows.
https://github.com/florianmichael/baseproject
gradle java jitpack maven-central publishing reposilite template
Last synced: about 1 month ago
JSON representation
Gradle template project with jar signing, publishing to maven central and GitHub workflows.
- Host: GitHub
- URL: https://github.com/florianmichael/baseproject
- Owner: FlorianMichael
- License: apache-2.0
- Created: 2023-10-15T09:37:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-30T05:10:15.000Z (about 2 months ago)
- Last Synced: 2024-10-30T08:32:30.271Z (about 2 months ago)
- Topics: gradle, java, jitpack, maven-central, publishing, reposilite, template
- Language: Java
- Homepage:
- Size: 264 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# BaseProject
Gradle template project with jar signing, publishing to maven central and GitHub workflows.
## Setup the required environment variables
You need to add the following environment variables to your gradle.properties file, which is located in the .gradle folder
in your home directory.
```properties
# Signing properties, see https://docs.gradle.org/current/userguide/signing_plugin.html#sec:signatory_credentials
signing.keyId=
signing.password=
signing.secretKeyRingFile=
# Reposilite credentials (In case you want to publish to a reposilite instance)
reposiliteUsername=
reposilitePassword=
# Maven central credentials (In case you want to publish to maven central)
# See https://central.sonatype.org/publish/publish-maven-gradle/
# This will also require to set up the signing properties
ossrhUsername=
ossrhPassword= # This is an access token nowadays
```
## Publishing
Use `./gradlew publishAllPublicationsToOssrhRepository` to publish to maven central.
Use `./gradlew publishAllPublicationsToReposiliteRepository` to publish to a reposilite instance.
Use `./gradlew publish` to publish to both.
## Building
Use `./gradlew clean build` to build the project.
## Final steps
- Change all mentions of `BaseProject` to your project name.
- Change the maven coordinates in the `gradle.properties` file.
- Change the author/email in all files. (Replace `FlorianMichael/EnZaXD` with your own name, ...)
- Update the license header located in `.idea/copyright/Apache_2_0.xml`
- Update the publishing section in the build.gradle file.
- Delete the all sections between the `Setup the required environment variables` and `Final steps` sections.
- Update the `How to add this to your project` section to only mention the repositories you are publishing to.
# Why another base project?
I wanted to have a template project for my own projects, which I can use to quickly start a new project.
## Contact
If you encounter any issues, please report them on the [issue tracker](https://github.com/FlorianMichael/BaseProject/issues). If you just want to talk or need help with BaseProject feel free to join my [Discord](https://discord.gg/BwWhCHUKDf).
## How to add this to your project
### Gradle/Maven
To use BaseProject with Gradle/Maven you can use [Maven Central](https://mvnrepository.com/artifact/de.florianmichael/BaseProject), [Lenni0451's Maven](https://maven.lenni0451.net/#/releases/de/florianmichael/BaseProject) or [Jitpack](https://jitpack.io/#FlorianMichael/BaseProject).
You can also find instructions how to implement it into your build script there.
### Jar File
If you just want the latest jar file you can download it from the GitHub [Actions](https://github.com/FlorianMichael/BaseProject/actions) or use the [Release](https://github.com/FlorianMichael/BaseProject/releases).