Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xenoterracide/gradle-convention
My convention plugins
https://github.com/xenoterracide/gradle-convention
auto-updates gradle gradle-plugin
Last synced: 22 days ago
JSON representation
My convention plugins
- Host: GitHub
- URL: https://github.com/xenoterracide/gradle-convention
- Owner: xenoterracide
- Created: 2024-10-02T15:51:55.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-20T03:18:13.000Z (3 months ago)
- Last Synced: 2024-10-20T03:24:04.245Z (3 months ago)
- Topics: auto-updates, gradle, gradle-plugin
- Language: Java
- Homepage:
- Size: 145 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# My Conventions
Firstly these are my personal conventions; if you find them useful feel free to let me know and I can migrate them to a
stable API. You're welcome to use them either way.
## Coverage
This plugin is designed to enforce a minimum coverage percentage per module, and also ensures that all `JvmTestSuite`s
are combined so that coverage is calculated across all tests. Instead of providing a ridiculous `BigDecimal` to the
plugin you can simply set a double to the minimum coverage percentage. The default percentage required is 90% or `0.9`.
```kts
plugins {
id("com.xenoterracide.gradle.convention.coverage")
}
coverage {
minimum.set(0.3) // default 0.9
}
```
## Publish
**WARNING:** this plugin sets up defaults for me, that will _not_ be suitable for your project.
See the [`package-info`](https://github.com/xenoterracide/gradle-convention/blob/main/module/publish/src/main/java/com/xenoterracide/gradle/convention/publish/package-info.java)
## Contributing
### Languages
[asdf](https://asdf-vm.com) is suggested, you can use whatever you'd like to get
- Java 11+
- NodeJs
add a way to export these to your `PATH` in your `~/.profile`
### Build Tools
- [Gradle](https://docs.gradle.org/current/userguide/command_line_interface.html)
- [NPM](https://docs.npmjs.com/about-npm)
#### Fetching Dependencies
In order to get snapshots of dependencies, you must have a GitHub token in your `~/.gradle/gradle.properties` file. This
file should look like:
```properties
ghUsername =
ghPassword =
```
You should generate your PAT
as [Github Documents here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#authenticating-to-github-packages).
> a personal access token (classic) with at least read:packages scope to install packages associated with other private
> repositories (which GITHUB_TOKEN can't access).
Then run.
Run `npm ci && ./gradlew dependencies` to install dependencies.
### Committing
Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
## Licenses
- Java and resulting Jars: [Apache-2.0](https://choosealicense.com/licenses/apache-2.0/)
- Gradle Kotlin and Config Files: [MIT](https://choosealicense.com/licenses/mit/)
- Documentation including Javadoc: [CC-BY-NC-4.0](https://creativecommons.org/licenses/by-nc/4.0/)
© Copyright 2024 Caleb Cushing.