https://github.com/metaborg/gitonium
Gradle plugin for automatic versioning based on Git branch and tag
https://github.com/metaborg/gitonium
git gradle gradle-plugin gradle-plugins publishing versioning
Last synced: 4 months ago
JSON representation
Gradle plugin for automatic versioning based on Git branch and tag
- Host: GitHub
- URL: https://github.com/metaborg/gitonium
- Owner: metaborg
- License: apache-2.0
- Created: 2019-02-21T14:51:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T09:54:02.000Z (about 2 years ago)
- Last Synced: 2024-05-22T10:55:59.688Z (about 2 years ago)
- Topics: git, gradle, gradle-plugin, gradle-plugins, publishing, versioning
- Language: Kotlin
- Size: 189 KB
- Stars: 4
- Watchers: 13
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Gitonium
[![Build][github-badge:build]][github:build]
[![License][license-badge]][license]
[![GitHub Release][github-badge:release]][github:release]
[![Documentation][documentation-badge]][documentation]
Gitonium is a Gradle plugin for automatic versioning based on the current Git branch and/or tag.
[![Documentation][documentation-button]][documentation]
## Spoofax 3 Artifacts
| Gradle Plugin | Latest Release | Latest Snapshot |
|---------------|----------------|-----------------|
| `org.metaborg.gitonium` | [![Release][mvn-rel-badge:org.metaborg.gitonium:org.metaborg.gitonium.gradle.plugin]][mvn:org.metaborg.gitonium:org.metaborg.gitonium.gradle.plugin] | [![Snapshot][mvn-snap-badge:org.metaborg.gitonium:org.metaborg.gitonium.gradle.plugin]][mvn:org.metaborg.gitonium:org.metaborg.gitonium.gradle.plugin] |
## Requirements
Gradle 7 or higher is required. The code snippets in this README assume you are using Gradle with Kotlin, but should be translatable to Groovy as well.
## Prerequisites
The Gitonium plugin is not yet published to the Gradle plugins repository. Therefore, to enable downloading the plugin, add our repository to your `settings.gradle(.kts)` file:
```kotlin
pluginManagement {
repositories {
maven("https://artifacts.metaborg.org/content/repositories/releases/")
}
}
```
## Applying the plugin
Apply the gitonium plugin to a project (a `build.gradle(.kts)` file) as follows:
```kotlin
plugins {
id("org.metaborg.gitonium") version ""
}
version = gitonium.version
```
The latest version of the plugin can be found at the top of this README. Gitonium will then lazily set the version of the project, and all sub-projects, to a version based on the Git repository. To override the version of a project, simply set the version manually, and this will override the lazily set version.
## Usage
Gitonium sets the version of the project based on the latest version tag (of the form `release-{version}`) found on the current branch. For example, if the HEAD of the current branch is tagged `release-0.1.3`, then the version is assigned `0.1.3`. Alternatively, if an earlier commit on the `develop` branch is tagged `release-0.1.3`, then the version `0.1.4-develop-SNAPSHOT` is assigned, one patch version higher than the last release.
If no release tag was found, the version is not set and therefore defaults to Gradle's default version of `unspecified`.
If the repository has no HEAD, Gitonium will fail.
> [!IMPORTANT]
> A shallow clone of a repository (as commonly performed by CI) might not checkout the tags of the repository.
> In this case, Gitonium will fail to find the version tag.
>
> For example, when using GitHub CI `actions/checkout` action, specify a non-shallow checkout including tags:
>
> ```yaml
> - name: Checkout
> uses: actions/checkout@v4
> with:
> fetch-depth: 0
> fetch-tags: true
> ```
## License
Copyright 2018-2024 [Programming Languages Group](https://pl.ewi.tudelft.nl/), [Delft University of Technology](https://www.tudelft.nl/)
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an **"as is" basis, without warranties or conditions of any kind**, either express or implied. See the License for the specific language governing permissions and limitations under the License.
[github-badge:build]: https://img.shields.io/github/actions/workflow/status/metaborg/gitonium/build.yaml
[github:build]: https://github.com/metaborg/gitonium/actions
[license-badge]: https://img.shields.io/github/license/metaborg/gitonium
[license]: https://github.com/metaborg/gitonium/blob/master/LICENSE.md
[github-badge:release]: https://img.shields.io/github/v/release/metaborg/gitonium?display_name=release
[github:release]: https://github.com/metaborg/gitonium/releases
[documentation-badge]: https://img.shields.io/badge/docs-latest-brightgreen
[documentation]: https://spoofax.dev/gitonium/
[documentation-button]: https://img.shields.io/badge/Documentation-blue?style=for-the-badge&logo=googledocs&logoColor=white
[mvn:org.metaborg.gitonium:org.metaborg.gitonium.gradle.plugin]: https://artifacts.metaborg.org/#nexus-search;gav~org.metaborg.gitonium~org.metaborg.gitonium.gradle.plugin~~~
[mvn-rel-badge:org.metaborg.gitonium:org.metaborg.gitonium.gradle.plugin]: https://img.shields.io/nexus/r/org.metaborg.gitonium/org.metaborg.gitonium.gradle.plugin?server=https%3A%2F%2Fartifacts.metaborg.org&label=%20
[mvn-snap-badge:org.metaborg.gitonium:org.metaborg.gitonium.gradle.plugin]: https://img.shields.io/nexus/s/org.metaborg.gitonium/org.metaborg.gitonium.gradle.plugin?server=https%3A%2F%2Fartifacts.metaborg.org&label=%20