From 40a2ed30f024d5168e120b434bc4d036a47de285 Mon Sep 17 00:00:00 2001 From: Philipp Heuer Date: Sun, 28 Feb 2021 16:43:37 +0100 Subject: [PATCH] chore: add docs for planned ci services --- README.md | 30 +++++++++++++++++++++++++++++- pkg_wip/appveyor/README.md | 19 +++++++++++++++++++ pkg_wip/awscodebuild/README.md | 19 +++++++++++++++++++ pkg_wip/bamboo/README.md | 19 +++++++++++++++++++ pkg_wip/bitbucket/README.md | 19 +++++++++++++++++++ pkg_wip/bitrise/README.md | 19 +++++++++++++++++++ pkg_wip/buddy/README.md | 19 +++++++++++++++++++ pkg_wip/buildkite/README.md | 19 +++++++++++++++++++ pkg_wip/circleci/README.md | 19 +++++++++++++++++++ pkg_wip/cirrusci/README.md | 19 +++++++++++++++++++ pkg_wip/codefresh/README.md | 19 +++++++++++++++++++ pkg_wip/codeship/README.md | 19 +++++++++++++++++++ pkg_wip/drone/README.md | 19 +++++++++++++++++++ pkg_wip/jenkins/README.md | 19 +++++++++++++++++++ pkg_wip/sailci/README.md | 19 +++++++++++++++++++ pkg_wip/semaphore/README.md | 19 +++++++++++++++++++ pkg_wip/shippable/README.md | 19 +++++++++++++++++++ pkg_wip/teamcity/README.md | 19 +++++++++++++++++++ pkg_wip/travisci/README.md | 19 +++++++++++++++++++ pkg_wip/wercker/README.md | 19 +++++++++++++++++++ 20 files changed, 390 insertions(+), 1 deletion(-) create mode 100644 pkg_wip/appveyor/README.md create mode 100644 pkg_wip/awscodebuild/README.md create mode 100644 pkg_wip/bamboo/README.md create mode 100644 pkg_wip/bitbucket/README.md create mode 100644 pkg_wip/bitrise/README.md create mode 100644 pkg_wip/buddy/README.md create mode 100644 pkg_wip/buildkite/README.md create mode 100644 pkg_wip/circleci/README.md create mode 100644 pkg_wip/cirrusci/README.md create mode 100644 pkg_wip/codefresh/README.md create mode 100644 pkg_wip/codeship/README.md create mode 100644 pkg_wip/drone/README.md create mode 100644 pkg_wip/jenkins/README.md create mode 100644 pkg_wip/sailci/README.md create mode 100644 pkg_wip/semaphore/README.md create mode 100644 pkg_wip/shippable/README.md create mode 100644 pkg_wip/teamcity/README.md create mode 100644 pkg_wip/travisci/README.md create mode 100644 pkg_wip/wercker/README.md diff --git a/README.md b/README.md index e46f7d2..20954ab 100644 --- a/README.md +++ b/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` diff --git a/pkg_wip/appveyor/README.md b/pkg_wip/appveyor/README.md new file mode 100644 index 0000000..7941634 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/awscodebuild/README.md b/pkg_wip/awscodebuild/README.md new file mode 100644 index 0000000..41fc557 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/bamboo/README.md b/pkg_wip/bamboo/README.md new file mode 100644 index 0000000..4a61475 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/bitbucket/README.md b/pkg_wip/bitbucket/README.md new file mode 100644 index 0000000..c75ddf1 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/bitrise/README.md b/pkg_wip/bitrise/README.md new file mode 100644 index 0000000..2567f97 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/buddy/README.md b/pkg_wip/buddy/README.md new file mode 100644 index 0000000..7ad0703 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/buildkite/README.md b/pkg_wip/buildkite/README.md new file mode 100644 index 0000000..1661c25 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/circleci/README.md b/pkg_wip/circleci/README.md new file mode 100644 index 0000000..8361447 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/cirrusci/README.md b/pkg_wip/cirrusci/README.md new file mode 100644 index 0000000..6dcade2 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/codefresh/README.md b/pkg_wip/codefresh/README.md new file mode 100644 index 0000000..c8aa281 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/codeship/README.md b/pkg_wip/codeship/README.md new file mode 100644 index 0000000..f1f9833 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/drone/README.md b/pkg_wip/drone/README.md new file mode 100644 index 0000000..4cce39f --- /dev/null +++ b/pkg_wip/drone/README.md @@ -0,0 +1,19 @@ +# Drone + +## sources + +- [Predefined variables](https://readme.drone.io/reference/environ/) + +## detection + +... + +## resources + +... + +## example variables + +```bash +... +``` diff --git a/pkg_wip/jenkins/README.md b/pkg_wip/jenkins/README.md new file mode 100644 index 0000000..cca82fa --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/sailci/README.md b/pkg_wip/sailci/README.md new file mode 100644 index 0000000..6d3127f --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/semaphore/README.md b/pkg_wip/semaphore/README.md new file mode 100644 index 0000000..2042f5f --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/shippable/README.md b/pkg_wip/shippable/README.md new file mode 100644 index 0000000..e058a67 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/teamcity/README.md b/pkg_wip/teamcity/README.md new file mode 100644 index 0000000..86fdf79 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/travisci/README.md b/pkg_wip/travisci/README.md new file mode 100644 index 0000000..fe6ed87 --- /dev/null +++ b/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 +... +``` diff --git a/pkg_wip/wercker/README.md b/pkg_wip/wercker/README.md new file mode 100644 index 0000000..288110d --- /dev/null +++ b/pkg_wip/wercker/README.md @@ -0,0 +1,19 @@ +# Wercker + +## sources + +- [Predefined variables](http://devcenter.wercker.com/docs/environment-variables/available-env-vars#hs_cos_wrapper_name) + +## detection + +... + +## resources + +... + +## example variables + +```bash +... +```