mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-22 02:25:34 +01:00
Updated Project Setup (markdown)
parent
db696b6d7a
commit
79f7895839
@ -55,4 +55,58 @@ gradle checkstyleMain checkstyleTest
|
||||
|
||||
# More
|
||||
|
||||
If you would like to know a bit more how the project is put together before diving in, you can check out [[Project Architecture]]
|
||||
If you would like to know a bit more how the project is put together before diving in, you can check out [[Project Architecture]]
|
||||
|
||||
The following sections are documentation for different one-time set-up steps for the project, written down in case I need to do it again years after I forgot about it.
|
||||
|
||||
## CI set-up
|
||||
|
||||
Some tests need additional resources to be run, such as MySQL test or Selenium tests. It is not expected for devs to set these up on their own machines, but they should run on the CI.
|
||||
|
||||
The resource information is set using environmental variables. Those can be found from https://github.com/plan-player-analytics/Plan/blob/master/Plan/common/src/test/java/utilities/CIProperties.java
|
||||
|
||||
## Bintray publish set-up
|
||||
|
||||
In order to publish artifacts to Bintray, following environmental variables need to be set
|
||||
|
||||
- `BINTRAY_KEY`: get from https://bintray.com/profile/edit > API Keys
|
||||
- `BINTRAY_USER`: Bintray username
|
||||
|
||||
build gradle config for bintray (At the time of writing this is in the API module)
|
||||
```groovy
|
||||
bintray {
|
||||
user = System.getenv('BINTRAY_USER')
|
||||
key = System.getenv('BINTRAY_KEY')
|
||||
pkg {
|
||||
repo = 'Plan-repository'
|
||||
name = 'Plan-API'
|
||||
licenses = ['LGPL-v3.0']
|
||||
vcsUrl = 'https://github.com/plan-player-analytics/Plan'
|
||||
issueTrackerUrl = 'https://github.com/plan-player-analytics/Plan/issues'
|
||||
version {
|
||||
name = "$apiVersion"
|
||||
desc = "Plan API version $apiVersion"
|
||||
}
|
||||
publications = ['BintrayPublication']
|
||||
}
|
||||
}
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
BintrayPublication(MavenPublication) {
|
||||
groupId = 'com.djrapitops'
|
||||
artifactId = 'Plan-api'
|
||||
version = "$apiVersion"
|
||||
|
||||
artifact jar
|
||||
}
|
||||
mavenJava(MavenPublication) {
|
||||
groupId = 'com.djrapitops'
|
||||
artifactId = 'Plan-api'
|
||||
version = "$apiVersion"
|
||||
|
||||
artifact jar
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
Loading…
Reference in New Issue
Block a user