Files
hlaeja-common-plugin/README.md
2024-11-01 20:16:14 +00:00

57 lines
1.6 KiB
Markdown

# Hlæja Common Plugin
Plugins for the libraries, lofty and grand, Plugins for the services, steadfast as stone, Plugins for the common, bound to their fate, Using the one plugin to rule them all, and in automation bind them, In the realm of code, where the builds take form.
## Plugins
### Plugin Common
id `ltd.hlaeja.plugin.hlaeja-common-plugin.common`
Set core Java and Kotlin settings and overweight project version with git version.
#### Gradle Tasks
* `buildInfo` display name and version, add to `build` task.
* `projectInfo` display project, Gradle, and Java information
### Plugin Common Detekt
id `ltd.hlaeja.plugin.hlaeja-common-plugin.common-detekt`
Detect is a code smell analysis for your Kotlin projects.
## Releasing plugin
Run `release.sh` script from `master` branch.
## Publishing plugin
### Publish plugin locally
```shell
./gradlew clean build publishToMavenLocal
```
### Publish plugin to repository
```shell
./gradlew clean build publish
```
### Global gradle properties
To authenticate with Gradle to access repositories that require authentication, you can set your user and token in the `gradle.properties` file.
Here's how you can do it:
1. Open or create the `gradle.properties` file in your Gradle user home directory:
- On Unix-like systems (Linux, macOS), this directory is typically `~/.gradle/`.
- On Windows, this directory is typically `C:\Users\<YourUsername>\.gradle\`.
2. Add the following lines to the `gradle.properties` file:
```properties
repository.user=your_user
repository.token=your_token_value
```
or use environment variables `REPOSITORY_USER` and `REPOSITORY_TOKEN`