sbt-garrity-software/README.md

36 lines
626 B
Markdown

# sbt-garrity-software
General SBT plugin for Garrity Software projects. This plugin should not be used
for non-GS projects.
> [!important]
> As of version 0.8.0, this plugin is only compatible with SBT 2.0.0+
## Usage
**File: project/plugins.sbt**
```scala
resolvers += "Garrity Software Releases" at "https://maven.garrity.co/gs"
addSbtPlugin("gs" % "sbt-garrity-software" % "0.8.0")
```
**File: build.sbt**
```scala
ThisBuild / gsProjectName := "project-name"
```
## Publishing
First, update the `CurrentVersion` value.
```
sbt publish
```
Then:
```
git tag $CURRENT_VERSION
git push origin $CURRENT_VERSION
```