Skip to content

Commit d305b01

Browse files
authored
doc: add release process info
1 parent 66a660a commit d305b01

1 file changed

Lines changed: 21 additions & 6 deletions

File tree

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
1-
TeraConfig
2-
==========
1+
# TeraConfig
32

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

65
* CheckStyle
76
* FindBugs
87
* PMD
98

10-
To use it, simply add it as a dependency and refer to it from the different tools like so:
9+
## Using TeraConfig
10+
11+
Add the Terasology Artifactory to `repositories` in your gradle build file (e.g. `build.gradle`):
12+
```gradle
13+
maven {
14+
name = "Terasology Artifactory"
15+
url = "http://artifactory.terasology.org/artifactory/virtual-repo-live"
16+
allowInsecureProtocol = true // 😱
17+
}
18+
```
19+
20+
With that, simply add it as a dependency and refer to it from the different tools like so:
1121

1222
```gradle
1323
configurations {
1424
codeMetrics
1525
}
1626
1727
dependencies {
18-
codeMetrics(group: 'org.terasology.config', name: 'codemetrics', version: '1.0.0', ext: 'zip')
28+
codeMetrics(group: 'org.terasology.config', name: 'codemetrics', version: '1.6.3', ext: 'zip')
1929
}
2030
2131
checkstyle {
@@ -30,5 +40,10 @@ findbugs {
3040
excludeFilterConfig = resources.text.fromArchiveEntry(configurations.codeMetrics, "findbugs/findbugs-exclude.xml")
3141
}
3242
```
33-
34-
This is it!
43+
44+
## Releasing TeraConfig
45+
46+
1. Tag a commit according to the version you'd like to release
47+
- _the tag should be valid [SemVer](https://semver.org/#semantic-versioning-specification-semver) prefixed with `v`, e.g. `v1.2.3`_
48+
2. Push the tag
49+
3. The github action configured in this repository will automatically create and publish the respective artifact

0 commit comments

Comments
 (0)