https://github.com/movingblocks/teraconfig
Contains configuration files for Terasology-related repositories
https://github.com/movingblocks/teraconfig
Last synced: 3 months ago
JSON representation
Contains configuration files for Terasology-related repositories
- Host: GitHub
- URL: https://github.com/movingblocks/teraconfig
- Owner: MovingBlocks
- License: apache-2.0
- Created: 2014-12-01T14:20:22.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-11-19T10:22:57.000Z (about 2 years ago)
- Last Synced: 2025-01-04T18:32:42.916Z (about 1 year ago)
- Size: 243 KB
- Stars: 2
- Watchers: 10
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TeraConfig
Contains configuration files for Terasology-related repositories. This repository contains configuration files for code Analytics:
* CheckStyle
* FindBugs
* PMD
## 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.6.3', ext: 'zip')
}
checkstyle {
config = resources.text.fromArchiveEntry(configurations.codeMetrics, "checkstyle/checkstyle.xml")
}
pmd {
ruleSetConfig = resources.text.fromArchiveEntry(configurations.codeMetrics, "pmd/pmd.xml")
}
findbugs {
excludeFilterConfig = resources.text.fromArchiveEntry(configurations.codeMetrics, "findbugs/findbugs-exclude.xml")
}
```
## 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