Skip to content

Commit

Permalink
doc: add release process info
Browse files Browse the repository at this point in the history
  • Loading branch information
jdrueckert authored Jun 13, 2021
1 parent 66a660a commit d305b01
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
TeraConfig
==========
# TeraConfig

Contains configuration files for Terasology-related repositories. This repository contains configuration files for code Analytics:

* CheckStyle
* FindBugs
* PMD

To use it, simply add it as a dependency and refer to it from the different tools like so:
## Using TeraConfig

Add the Terasology Artifactory to `repositories` in your gradle build file (e.g. `build.gradle`):
```gradle
maven {
name = "Terasology Artifactory"
url = "http://artifactory.terasology.org/artifactory/virtual-repo-live"
allowInsecureProtocol = true // 😱
}
```

With that, simply add it as a dependency and refer to it from the different tools like so:

```gradle
configurations {
codeMetrics
}
dependencies {
codeMetrics(group: 'org.terasology.config', name: 'codemetrics', version: '1.0.0', ext: 'zip')
codeMetrics(group: 'org.terasology.config', name: 'codemetrics', version: '1.6.3', ext: 'zip')
}
checkstyle {
Expand All @@ -30,5 +40,10 @@ findbugs {
excludeFilterConfig = resources.text.fromArchiveEntry(configurations.codeMetrics, "findbugs/findbugs-exclude.xml")
}
```

This is it!

## Releasing TeraConfig

1. Tag a commit according to the version you'd like to release
- _the tag should be valid [SemVer](https://semver.org/#semantic-versioning-specification-semver) prefixed with `v`, e.g. `v1.2.3`_
2. Push the tag
3. The github action configured in this repository will automatically create and publish the respective artifact

0 comments on commit d305b01

Please sign in to comment.