chore: add docs for planned ci services

README.md

@@ -1,6 +1,8 @@
 # normalize.ci
 
-> A tool to turn the continious integration / deployment variables into a common format for generally usable scripts without any dependencies.
+> A cli tool to convert continuous integration / deployment variables into a common format for generally usable scripts without any dependencies.
+
+This project can also be used as library for other tools.
 
 ## installation
 
@@ -29,3 +31,29 @@ NAME | SLUG
 [Local Git Repository](pkg/localgit/README.md) | `local`
 
 *Note:* If none of the above systems is detected, repository information is determined based on the local Git repository.
+
+## planned systems
+
+*Note:*: If you want to contribute, feel free to pick one of the following services and add a package to normalize their variables.
+
+NAME | SLUG
+--- | --- |
+[AppVeyor](pkg_wip/appveyor/README.md) | `appveyor`
+[AWS CodeBuild](pkg_wip/awscodebuild/README.md) | `aws-codebuild`
+[Bamboo](pkg_wip/bamboo/README.md) | `bamboo`
+[Bitbucket](pkg_wip/bitbucket/README.md) | `bitbucket`
+[Bitrise](pkg_wip/bitrise/README.md) | `bitrise`
+[Buddy](pkg_wip/buddy/README.md) | `buddy`
+[Buildkite](pkg_wip/buildkite/README.md) | `buildkite`
+[CircleCI](pkg_wip/circleci/README.md) | `circleci`
+[Cirrus CI](pkg_wip/cirrusci/README.md) | `cirrusci`
+[Codefresh](pkg_wip/codefresh/README.md) | `codefresh`
+[Codeship](pkg_wip/codeship/README.md) | `codeship`
+[Drone](pkg_wip/drone/README.md) | `drone`
+[Jenkins](pkg_wip/jenkins/README.md) | `jenkins`
+[Sail CI](pkg_wip/sailci/README.md) | `sailci`
+[Semaphore](pkg_wip/semaphore/README.md) | `semaphore`
+[Shippable](pkg_wip/shippable/README.md) | `shippable`
+[TeamCity](pkg_wip/teamcity/README.md) | `teamcity`
+[Travis CI](pkg_wip/travisci/README.md) | `travis-ci`
+[Wercker](pkg_wip/wercker/README.md) | `wercker`

pkg_wip/appveyor/README.md

@@ -0,0 +1,19 @@
+# AppVeyor
+
+## sources
+
+- [Predefined variables](https://www.appveyor.com/docs/environment-variables)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/awscodebuild/README.md

@@ -0,0 +1,19 @@
+# AWS CodeBuild
+
+## sources
+
+- [Predefined variables](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/bamboo/README.md

@@ -0,0 +1,19 @@
+# Bamboo
+
+## sources
+
+- [Predefined variables](https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/bitbucket/README.md

@@ -0,0 +1,19 @@
+# Bitbucket
+
+## sources
+
+- [Predefined variables](https://confluence.atlassian.com/bitbucket/environment-variables-794502608.html)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/bitrise/README.md

@@ -0,0 +1,19 @@
+# Bitrise
+
+## sources
+
+- [Predefined variables](https://devcenter.bitrise.io/builds/available-environment-variables/#exposed-by-bitriseio)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/buddy/README.md

@@ -0,0 +1,19 @@
+# Buddy
+
+## sources
+
+- [Predefined variables](https://buddy.works/knowledge/deployments/how-use-environment-variables#default-environment-variables)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/buildkite/README.md

@@ -0,0 +1,19 @@
+# Buildkite
+
+## sources
+
+- [Predefined variables](https://buildkite.com/docs/builds/environment-variables)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/circleci/README.md

@@ -0,0 +1,19 @@
+# CircleCI
+
+## sources
+
+- [Predefined variables](https://circleci.com/docs/2.0/env-vars/#built-in-environment-variables)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/cirrusci/README.md

@@ -0,0 +1,19 @@
+# Cirrus CI
+
+## sources
+
+- [Predefined variables](https://cirrus-ci.org/guide/writing-tasks/#environment-variables)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/codefresh/README.md

@@ -0,0 +1,19 @@
+# Codefresh
+
+## sources
+
+- [Predefined variables](https://codefresh.io/docs/docs/codefresh-yaml/variables#system-provided-variables)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/codeship/README.md

@@ -0,0 +1,19 @@
+# Codeship
+
+## sources
+
+- [Predefined variables](https://documentation.codeship.com/basic/builds-and-configuration/set-environment-variables/#default-environment-variables)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/drone/README.md

@@ -0,0 +1,19 @@
+# Drone
+
+## sources
+
+- [Predefined variables](https://readme.drone.io/reference/environ/)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/jenkins/README.md

@@ -0,0 +1,19 @@
+# Jenkins
+
+## sources
+
+- [Predefined variables](https://wiki.jenkins.io/display/JENKINS/Building+a+software+project)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/sailci/README.md

@@ -0,0 +1,19 @@
+# Sail CI
+
+## sources
+
+- [Predefined variables](https://sail.ci/docs/environment-variables)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/semaphore/README.md

@@ -0,0 +1,19 @@
+# Semaphore
+
+## sources
+
+- [Predefined variables](https://semaphoreci.com/docs/available-environment-variables.html)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/shippable/README.md

@@ -0,0 +1,19 @@
+# Shippable
+
+## sources
+
+- [Predefined variables](http://docs.shippable.com/ci/env-vars/#stdEnv)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/teamcity/README.md

@@ -0,0 +1,19 @@
+# TeamCity
+
+## sources
+
+- [Predefined variables](https://confluence.jetbrains.com/display/TCD10/Predefined+Build+Parameters)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```

pkg_wip/travisci/README.md

@@ -0,0 +1,19 @@
+# Travis CI
+
+## sources
+
+- [Predefined variables](https://docs.travis-ci.com/user/environment-variables#default-environment-variables)
+
+## detection
+
+...
+
+## resources
+
+...
+
+## example variables
+
+```bash
+...
+```