diff --git a/docs/CI_TeamCity.md b/docs/CI_TeamCity.md index 3d4213b..575fc0a 100644 --- a/docs/CI_TeamCity.md +++ b/docs/CI_TeamCity.md @@ -13,18 +13,35 @@ forks. Just follow these steps to get your CI server up and running (order of op Feel free to change, archive, delete any of the sub-projects to fit your needs and write access. - ### Context Parameters -- `Fork`: [AsteroidOS]: The fork that should be attached to the current CI project -- (optional) `Upstream`: [AsteroidOS]: The upstream repository of all the other parent/child projects -- `Devices`: [sturgeon,catfish] A comma-separated list of devices you wish to manage -- `Packages`: [asteroid-launcher] A comma-separated list of Asteroid packages you wish to manage -- (optional) `Deploy Sstate`: [false] Whether the build should upload to the `sstate-cache` server -- (optional) `Integrate Github`: [false] Whether the build status should be pushed to your fork +For a full list check `.teamcity/$Project/Settings.kt`. + +- `Fork`: [AsteroidOS]
+The fork that should be attached to the current CI project. +- `Devices`: [sturgeon,catfish]
+A comma-separated list of devices you wish to manage. +- `Packages`: [asteroid-launcher]
+A comma-separated list of Asteroid packages you wish to manage. +- (optional) `Upstream`: [AsteroidOS]
+The upstream repository of all the other parent/child projects. +- (optional) `DeploySstate`: [false]
+Enables uploading to the `sstate-cache` server. +- (optional) `PullRequests`: [false]
+Enables tracking pull requests on `fork`. +- (optional) `CommitStatus`: [false]
+Enables pushing commit status to the `fork`. +- (optional) `CommitUser`: [`Fork`]
+The commit user pushing commit status. +*Required if `CommitStatus == true`*. ### Other configurations -- (optional) `Sstate Server Key`: The SSH key used to upload to your own `sstate-cache` server +- (optional) `$Project/SSH Keys/Sstate Server Key`
+The SSH key used to upload to your own `sstate-cache` server. +*Required if `DeploySstate == true`*. +- (optional) `$Project/Versioned Settings/Tokens/credentialsJSON:0b803d82-f0a8-42ee-b8f9-0fca109a14ab`
+Github OAuth token for `CommitUser` or your account. +*Required if `PullRequests || CommitStatus == true`*. ### Other Notes \ No newline at end of file