From 5256f22b77396877cd9fdb8ba7623e53ce675480 Mon Sep 17 00:00:00 2001 From: Sven Fuchs Date: Wed, 24 Apr 2019 21:07:59 +0200 Subject: [PATCH] serve example docs --- Gemfile | 1 + Gemfile.lock | 9 + config.ru | 17 +- lib/travis/yml/docs.rb | 49 +- lib/travis/yml/web/router.rb | 15 +- lib/travis/yml/web/v1.rb | 8 +- lib/travis/yml/web/v1/css.rb | 42 + lib/travis/yml/web/v1/docs.rb | 90 ++ public/css/docs/github.css | 409 +++++ public/css/docs/syntax.css | 255 ++++ public/docs/addon/apt.md | 58 + public/docs/addon/artifacts.md | 42 + public/docs/addon/browserstack.md | 34 + public/docs/addon/code_climate.md | 33 + public/docs/addon/coverity_scan.md | 44 + public/docs/addon/homebrew.md | 37 + public/docs/addon/jwts.md | 13 + public/docs/addon/sauce_connect.md | 32 + public/docs/addon/snaps.md | 44 + public/docs/deploy/anynines.md | 35 + public/docs/deploy/app.md | 27 + public/docs/deploy/appfog.md | 63 + public/docs/deploy/atlas.md | 40 + public/docs/deploy/azure_web_apps.md | 36 + public/docs/deploy/bintray.md | 36 + public/docs/deploy/bitballoon.md | 34 + public/docs/deploy/bluemixcf.md | 39 + public/docs/deploy/boxfuse.md | 40 + public/docs/deploy/branches.md | 22 + public/docs/deploy/catalyze.md | 33 + public/docs/deploy/chef_supermarket.md | 34 + public/docs/deploy/cloud66.md | 32 + public/docs/deploy/cloudcontrol.md | 34 + public/docs/deploy/cloudfiles.md | 36 + public/docs/deploy/cloudfoundry.md | 39 + public/docs/deploy/codedeploy.md | 42 + public/docs/deploy/conditions.md | 30 + public/docs/deploy/deis.md | 36 + public/docs/deploy/divshot.md | 33 + public/docs/deploy/edge.md | 29 + public/docs/deploy/elasticbeanstalk.md | 40 + public/docs/deploy/engineyard.md | 37 + public/docs/deploy/firebase.md | 34 + public/docs/deploy/gae.md | 38 + public/docs/deploy/gcs.md | 40 + public/docs/deploy/hackage.md | 33 + public/docs/deploy/heroku.md | 36 + public/docs/deploy/lambda.md | 51 + public/docs/deploy/launchpad.md | 34 + public/docs/deploy/modulus.md | 33 + public/docs/deploy/npm.md | 33 + public/docs/deploy/openshift.md | 36 + public/docs/deploy/opsworks.md | 39 + public/docs/deploy/packagecloud.md | 38 + public/docs/deploy/pages.md | 45 + public/docs/deploy/providers.md | 1032 +++++++++++++ public/docs/deploy/puppetforge.md | 34 + public/docs/deploy/pypi.md | 37 + public/docs/deploy/releases.md | 40 + public/docs/deploy/rubygems.md | 35 + public/docs/deploy/s3.md | 46 + public/docs/deploy/scalingo.md | 37 + public/docs/deploy/script.md | 32 + public/docs/deploy/surge.md | 33 + public/docs/deploy/testfairy.md | 47 + public/docs/index.md | 127 ++ public/docs/language/android.md | 13 + public/docs/language/c.md | 13 + public/docs/language/clojure.md | 13 + public/docs/language/cpp.md | 13 + public/docs/language/crystal.md | 13 + public/docs/language/csharp.md | 13 + public/docs/language/d.md | 13 + public/docs/language/dart.md | 13 + public/docs/language/elixir.md | 13 + public/docs/language/elm.md | 13 + public/docs/language/erlang.md | 13 + public/docs/language/go.md | 13 + public/docs/language/groovy.md | 13 + public/docs/language/haskell.md | 13 + public/docs/language/haxe.md | 13 + public/docs/language/java.md | 13 + public/docs/language/julia.md | 13 + public/docs/language/nix.md | 13 + public/docs/language/node_js.md | 13 + public/docs/language/objective-c.md | 13 + public/docs/language/perl.md | 13 + public/docs/language/perl6.md | 13 + public/docs/language/php.md | 13 + public/docs/language/python.md | 13 + public/docs/language/r.md | 13 + public/docs/language/ruby.md | 13 + public/docs/language/rust.md | 13 + public/docs/language/scala.md | 13 + public/docs/language/shell.md | 13 + public/docs/language/smalltalk.md | 13 + public/docs/notification/campfire.md | 37 + public/docs/notification/email.md | 36 + public/docs/notification/flowdock.md | 37 + public/docs/notification/frequency.md | 13 + public/docs/notification/hipchat.md | 40 + public/docs/notification/irc.md | 43 + public/docs/notification/pushover.md | 32 + public/docs/notification/slack.md | 38 + public/docs/notification/template.md | 13 + public/docs/notification/templates.md | 28 + public/docs/notification/webhooks.md | 37 + public/docs/type/addons.md | 13 + public/docs/type/arch.md | 13 + public/docs/type/archs.md | 28 + public/docs/type/branches.md | 28 + public/docs/type/cache.md | 39 + public/docs/type/compilers.md | 13 + public/docs/type/conditions.md | 13 + public/docs/type/deploys.md | 1888 ++++++++++++++++++++++++ public/docs/type/dist.md | 13 + public/docs/type/env.md | 61 + public/docs/type/env_var.md | 33 + public/docs/type/env_vars.md | 52 + public/docs/type/git.md | 13 + public/docs/type/group.md | 13 + public/docs/type/import.md | 28 + public/docs/type/imports.md | 43 + public/docs/type/job.md | 13 + public/docs/type/languages.md | 300 ++++ public/docs/type/matrix.md | 38 + public/docs/type/matrix_entries.md | 27 + public/docs/type/matrix_entry.md | 13 + public/docs/type/notifications.md | 53 + public/docs/type/os.md | 13 + public/docs/type/oss.md | 28 + public/docs/type/service.md | 13 + public/docs/type/services.md | 28 + public/docs/type/stack.md | 13 + public/docs/type/stage.md | 28 + public/docs/type/stages.md | 43 + public/docs/type/sudo.md | 27 + public/docs/type/version.md | 13 + 138 files changed, 7705 insertions(+), 29 deletions(-) create mode 100644 lib/travis/yml/web/v1/css.rb create mode 100644 lib/travis/yml/web/v1/docs.rb create mode 100644 public/css/docs/github.css create mode 100644 public/css/docs/syntax.css create mode 100644 public/docs/addon/apt.md create mode 100644 public/docs/addon/artifacts.md create mode 100644 public/docs/addon/browserstack.md create mode 100644 public/docs/addon/code_climate.md create mode 100644 public/docs/addon/coverity_scan.md create mode 100644 public/docs/addon/homebrew.md create mode 100644 public/docs/addon/jwts.md create mode 100644 public/docs/addon/sauce_connect.md create mode 100644 public/docs/addon/snaps.md create mode 100644 public/docs/deploy/anynines.md create mode 100644 public/docs/deploy/app.md create mode 100644 public/docs/deploy/appfog.md create mode 100644 public/docs/deploy/atlas.md create mode 100644 public/docs/deploy/azure_web_apps.md create mode 100644 public/docs/deploy/bintray.md create mode 100644 public/docs/deploy/bitballoon.md create mode 100644 public/docs/deploy/bluemixcf.md create mode 100644 public/docs/deploy/boxfuse.md create mode 100644 public/docs/deploy/branches.md create mode 100644 public/docs/deploy/catalyze.md create mode 100644 public/docs/deploy/chef_supermarket.md create mode 100644 public/docs/deploy/cloud66.md create mode 100644 public/docs/deploy/cloudcontrol.md create mode 100644 public/docs/deploy/cloudfiles.md create mode 100644 public/docs/deploy/cloudfoundry.md create mode 100644 public/docs/deploy/codedeploy.md create mode 100644 public/docs/deploy/conditions.md create mode 100644 public/docs/deploy/deis.md create mode 100644 public/docs/deploy/divshot.md create mode 100644 public/docs/deploy/edge.md create mode 100644 public/docs/deploy/elasticbeanstalk.md create mode 100644 public/docs/deploy/engineyard.md create mode 100644 public/docs/deploy/firebase.md create mode 100644 public/docs/deploy/gae.md create mode 100644 public/docs/deploy/gcs.md create mode 100644 public/docs/deploy/hackage.md create mode 100644 public/docs/deploy/heroku.md create mode 100644 public/docs/deploy/lambda.md create mode 100644 public/docs/deploy/launchpad.md create mode 100644 public/docs/deploy/modulus.md create mode 100644 public/docs/deploy/npm.md create mode 100644 public/docs/deploy/openshift.md create mode 100644 public/docs/deploy/opsworks.md create mode 100644 public/docs/deploy/packagecloud.md create mode 100644 public/docs/deploy/pages.md create mode 100644 public/docs/deploy/providers.md create mode 100644 public/docs/deploy/puppetforge.md create mode 100644 public/docs/deploy/pypi.md create mode 100644 public/docs/deploy/releases.md create mode 100644 public/docs/deploy/rubygems.md create mode 100644 public/docs/deploy/s3.md create mode 100644 public/docs/deploy/scalingo.md create mode 100644 public/docs/deploy/script.md create mode 100644 public/docs/deploy/surge.md create mode 100644 public/docs/deploy/testfairy.md create mode 100644 public/docs/index.md create mode 100644 public/docs/language/android.md create mode 100644 public/docs/language/c.md create mode 100644 public/docs/language/clojure.md create mode 100644 public/docs/language/cpp.md create mode 100644 public/docs/language/crystal.md create mode 100644 public/docs/language/csharp.md create mode 100644 public/docs/language/d.md create mode 100644 public/docs/language/dart.md create mode 100644 public/docs/language/elixir.md create mode 100644 public/docs/language/elm.md create mode 100644 public/docs/language/erlang.md create mode 100644 public/docs/language/go.md create mode 100644 public/docs/language/groovy.md create mode 100644 public/docs/language/haskell.md create mode 100644 public/docs/language/haxe.md create mode 100644 public/docs/language/java.md create mode 100644 public/docs/language/julia.md create mode 100644 public/docs/language/nix.md create mode 100644 public/docs/language/node_js.md create mode 100644 public/docs/language/objective-c.md create mode 100644 public/docs/language/perl.md create mode 100644 public/docs/language/perl6.md create mode 100644 public/docs/language/php.md create mode 100644 public/docs/language/python.md create mode 100644 public/docs/language/r.md create mode 100644 public/docs/language/ruby.md create mode 100644 public/docs/language/rust.md create mode 100644 public/docs/language/scala.md create mode 100644 public/docs/language/shell.md create mode 100644 public/docs/language/smalltalk.md create mode 100644 public/docs/notification/campfire.md create mode 100644 public/docs/notification/email.md create mode 100644 public/docs/notification/flowdock.md create mode 100644 public/docs/notification/frequency.md create mode 100644 public/docs/notification/hipchat.md create mode 100644 public/docs/notification/irc.md create mode 100644 public/docs/notification/pushover.md create mode 100644 public/docs/notification/slack.md create mode 100644 public/docs/notification/template.md create mode 100644 public/docs/notification/templates.md create mode 100644 public/docs/notification/webhooks.md create mode 100644 public/docs/type/addons.md create mode 100644 public/docs/type/arch.md create mode 100644 public/docs/type/archs.md create mode 100644 public/docs/type/branches.md create mode 100644 public/docs/type/cache.md create mode 100644 public/docs/type/compilers.md create mode 100644 public/docs/type/conditions.md create mode 100644 public/docs/type/deploys.md create mode 100644 public/docs/type/dist.md create mode 100644 public/docs/type/env.md create mode 100644 public/docs/type/env_var.md create mode 100644 public/docs/type/env_vars.md create mode 100644 public/docs/type/git.md create mode 100644 public/docs/type/group.md create mode 100644 public/docs/type/import.md create mode 100644 public/docs/type/imports.md create mode 100644 public/docs/type/job.md create mode 100644 public/docs/type/languages.md create mode 100644 public/docs/type/matrix.md create mode 100644 public/docs/type/matrix_entries.md create mode 100644 public/docs/type/matrix_entry.md create mode 100644 public/docs/type/notifications.md create mode 100644 public/docs/type/os.md create mode 100644 public/docs/type/oss.md create mode 100644 public/docs/type/service.md create mode 100644 public/docs/type/services.md create mode 100644 public/docs/type/stack.md create mode 100644 public/docs/type/stage.md create mode 100644 public/docs/type/stages.md create mode 100644 public/docs/type/sudo.md create mode 100644 public/docs/type/version.md diff --git a/Gemfile b/Gemfile index 9a63081e7..13ffb84c7 100644 --- a/Gemfile +++ b/Gemfile @@ -6,6 +6,7 @@ group :web do gem 'puma', '~> 3.12.0' gem 'rack', '~> 2.0.6' gem 'rack-cors', '~> 1.0.2' + gem 'rack-markdown' gem 'rack-ssl-enforcer', '~> 0.2.9' gem 'sentry-raven', '~> 2.9.0' gem 'travis-config', '~> 1.1.3' diff --git a/Gemfile.lock b/Gemfile.lock index a879ec08f..e59bfdc42 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -28,6 +28,7 @@ GEM method_source (0.8.2) mize (0.3.5) protocol + multi_json (1.13.1) multipart-post (2.0.0) neatjson (0.8.4) oj (3.7.12) @@ -39,12 +40,19 @@ GEM method_source (~> 0.8.1) slop (~> 3.4) puma (3.12.0) + pygments.rb (1.2.1) + multi_json (>= 1.0.0) rack (2.0.6) rack-cors (1.0.2) + rack-markdown (0.0.3) + pygments.rb + rack + redcarpet rack-ssl-enforcer (0.2.9) rack-test (1.1.0) rack (>= 1.0, < 3) rake (12.3.1) + redcarpet (3.4.0) regstry (1.0.2) rspec (3.7.0) rspec-core (~> 3.7.0) @@ -86,6 +94,7 @@ DEPENDENCIES puma (~> 3.12.0) rack (~> 2.0.6) rack-cors (~> 1.0.2) + rack-markdown rack-ssl-enforcer (~> 0.2.9) rack-test rake diff --git a/config.ru b/config.ru index 8d4e7de7c..0c2626ede 100644 --- a/config.ru +++ b/config.ru @@ -3,7 +3,13 @@ require 'rack/cors' require 'rack/ssl-enforcer' require 'travis/yml/web' -if Travis::Yaml::Web::Env.staging? +env = Travis::Yml::Web::Env + +if env.production? + use Rack::SslEnforcer + use Travis::Yml::Web::BasicAuth + +elsif env.staging? use Rack::Cors do allow do origins '*' @@ -12,15 +18,12 @@ if Travis::Yaml::Web::Env.staging? end end -use Rack::SslEnforcer if Travis::Yaml::Web::Env.production? -use Travis::Yaml::Web::BasicAuth unless Travis::Yaml::Web::Env.test? - -if ENV['SENTRY_DSN'] +if dsn = ENV['SENTRY_DSN'] Raven.configure do |config| - config.dsn = ENV['SENTRY_DSN'] + config.dsn = dsn end use Raven::Rack end -run Travis::Yaml::Web +run Travis::Yml::Web diff --git a/lib/travis/yml/docs.rb b/lib/travis/yml/docs.rb index fbd1c1393..036d35cf9 100644 --- a/lib/travis/yml/docs.rb +++ b/lib/travis/yml/docs.rb @@ -1,4 +1,5 @@ require 'erb' +require 'fileutils' module Travis module Yml @@ -85,39 +86,57 @@ def yaml(obj) yml = yml.sub("'on'", 'on') yml.strip end + + def write + FileUtils.mkdir_p(dir) + File.write(path, render) + end + + def path + @path ||= "#{dir}/#{node.id}.md" + end + + def dir + "public/docs/#{node.namespace}" + end end - extend self - extend Helper::Obj + class Index < Page + def render + node.map do |node| + "* [#{node.title}](/v1/docs/#{node.namespace}/#{node.id})" + end.join("\n") + end - def write - pages.map do |name, page| - File.write(path(name), page) + def path + "#{dir}/index.md" + end + + def dir + 'public/docs/' end - File.write(path(:index), index) end - def path(name) - "public/#{name}.md" + extend self + extend Helper::Obj + + def write + pages.each(&:write) + index.write end def pages - nodes.map do |node| - [[node.namespace, node.id].join('/'), Page.new(node).render] - end.to_h + nodes.map { |node| Page.new(node) } end def index - nodes.map do |node| - "* [#{node.title}](/#{node.namespace}/#{node.id}]" - end.join("\n") + Index.new(nodes) end def nodes Schema.schema nodes = Schema::Type::Node.exports.values.map(&:values).flatten nodes = nodes.reject(&:internal?) - # nodes = [Schema::Def::Stages.new.node.lookup] nodes = sort(nodes) nodes end diff --git a/lib/travis/yml/web/router.rb b/lib/travis/yml/web/router.rb index b6c553366..435c055a2 100644 --- a/lib/travis/yml/web/router.rb +++ b/lib/travis/yml/web/router.rb @@ -7,15 +7,20 @@ def initialize(map = {}) def call(env) req = Rack::Request.new(env) - env_path = req.path_info.chomp(?/) - env_path = ?/ if env_path.empty? + path = req.path_info.chomp(?/) + path = ?/ if path.empty? - @map.each do |path, app| - next if env_path.nil? || path.nil? - return app.call(env) if env_path == path + @map.each do |pattern, app| + next if path.nil? || pattern.nil? + return app.call(env) if match?(pattern, path) end [404, {}, []] end + + def match?(pattern, path) + return pattern == path unless pattern.include?('/*') + path.start_with?(pattern.sub('/*', '')) + end end end diff --git a/lib/travis/yml/web/v1.rb b/lib/travis/yml/web/v1.rb index a11606a6f..99ab010b9 100644 --- a/lib/travis/yml/web/v1.rb +++ b/lib/travis/yml/web/v1.rb @@ -1,5 +1,7 @@ # frozen_string_literal: true require 'travis/yml/web/router' +require 'travis/yml/web/v1/css' +require 'travis/yml/web/v1/docs' require 'travis/yml/web/v1/expand' require 'travis/yml/web/v1/home' require 'travis/yml/web/v1/parse' @@ -14,8 +16,10 @@ def call(env) def router @router ||= Router.new( - '/' => V1::Home.new, - '/parse' => V1::Parse.new, + '/' => V1::Home.new, + '/css/*' => V1::Css.new, + '/docs/*' => V1::Docs.new, + '/parse' => V1::Parse.new, '/expand' => V1::Expand.new ) end diff --git a/lib/travis/yml/web/v1/css.rb b/lib/travis/yml/web/v1/css.rb new file mode 100644 index 000000000..de7767f8f --- /dev/null +++ b/lib/travis/yml/web/v1/css.rb @@ -0,0 +1,42 @@ +# frozen_string_literal: true +require 'oj' +require 'rack/markdown' +require 'travis/yml/web/route' + +module Travis::Yml::Web + module V1 + class Css + include Route + + def get(env) + req = Rack::Request.new(env) + path = req.path_info.chomp(?/) + exists?(path) ? ok(path) : not_found + end + + def ok(path) + [200, headers, [read(path)]] + end + + def not_found + [404, headers, ['Not found']] + end + + def exists?(path) + File.exists?(file(path)) + end + + def read(path) + File.read(file(path)) + end + + def file(path) + "./public#{path.sub('..', '')}" + end + + def headers + { 'Content-Type' => 'text/css' } + end + end + end +end diff --git a/lib/travis/yml/web/v1/docs.rb b/lib/travis/yml/web/v1/docs.rb new file mode 100644 index 000000000..583fb61be --- /dev/null +++ b/lib/travis/yml/web/v1/docs.rb @@ -0,0 +1,90 @@ +# frozen_string_literal: true +require 'oj' +require 'rack/markdown' +require 'travis/yml/web/route' + +Rack::Markdown::CSS.class_eval do + def external + hrefs = %w(/v1/css/docs/github.css /v1/css/docs/syntax.css) + links = hrefs.map { |h| "" } + links.join + end +end + +Rack::Markdown::HTML.class_eval do + def body + <<-HTML + +
+
+ #{index} +
+
+ #{rendered} +
+
+ HTML + end +end + +Rack::Markdown.class_eval do + def index + Rack::Markdown::Renderer.render(File.read('public/docs/index.md')) + end +end + +module Travis::Yml::Web + module V1 + class Docs + include Route + + def get(env) + req = Rack::Request.new(env) + path = req.path_info.chomp(?/) + exists?(path) ? ok(path) : not_found + end + + def ok(path) + Rack::Markdown.new(file(path)).call(nil) + end + + def not_found + [404, headers, ['Not found']] + end + + def exists?(path) + File.exists?(file(path)) + end + + def file(path) + "./public#{path.sub('..', '')}.md" + end + + def headers + { 'Content-Type' => 'text/html' } + end + end + end +end diff --git a/public/css/docs/github.css b/public/css/docs/github.css new file mode 100644 index 000000000..76c2008f8 --- /dev/null +++ b/public/css/docs/github.css @@ -0,0 +1,409 @@ +/* +Copyright (c) 2017 Chris Patuzzo +https://twitter.com/chrispatuzzo + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +body { + font-family: Helvetica, arial, sans-serif; + font-size: 14px; + line-height: 1.6; + padding-top: 10px; + padding-bottom: 10px; + background-color: white; + padding: 30px; + color: #333; +} + +body > *:first-child { + margin-top: 0 !important; +} + +body > *:last-child { + margin-bottom: 0 !important; +} + +a { + color: #4183C4; + text-decoration: none; +} + +a.absent { + color: #cc0000; +} + +a.anchor { + display: block; + padding-left: 30px; + margin-left: -30px; + cursor: pointer; + position: absolute; + top: 0; + left: 0; + bottom: 0; +} + +h1, h2, h3, h4, h5, h6 { + margin: 20px 0 10px; + padding: 0; + font-weight: bold; + -webkit-font-smoothing: antialiased; + cursor: text; + position: relative; +} + +h2:first-child, h1:first-child, h1:first-child + h2, h3:first-child, h4:first-child, h5:first-child, h6:first-child { + margin-top: 0; + padding-top: 0; +} + +h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, h5:hover a.anchor, h6:hover a.anchor { + text-decoration: none; +} + +h1 tt, h1 code { + font-size: inherit; +} + +h2 tt, h2 code { + font-size: inherit; +} + +h3 tt, h3 code { + font-size: inherit; +} + +h4 tt, h4 code { + font-size: inherit; +} + +h5 tt, h5 code { + font-size: inherit; +} + +h6 tt, h6 code { + font-size: inherit; +} + +h1 { + font-size: 28px; + color: black; +} + +h2 { + font-size: 24px; + border-bottom: 1px solid #cccccc; + color: black; +} + +h3 { + font-size: 18px; +} + +h4 { + font-size: 16px; +} + +h5 { + font-size: 14px; +} + +h6 { + color: #777777; + font-size: 14px; +} + +p, blockquote, ul, ol, dl, li, table, pre { + margin: 15px 0; +} + +hr { + border: 0 none; + color: #cccccc; + height: 4px; + padding: 0; +} + +body > h2:first-child { + margin-top: 0; + padding-top: 0; +} + +body > h1:first-child { + margin-top: 0; + padding-top: 0; +} + +body > h1:first-child + h2 { + margin-top: 0; + padding-top: 0; +} + +body > h3:first-child, body > h4:first-child, body > h5:first-child, body > h6:first-child { + margin-top: 0; + padding-top: 0; +} + +a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 { + margin-top: 0; + padding-top: 0; +} + +h1 p, h2 p, h3 p, h4 p, h5 p, h6 p { + margin-top: 0; +} + +li p.first { + display: inline-block; +} + +ul, ol { + padding-left: 30px; +} + +ul :first-child, ol :first-child { + margin-top: 0; +} + +ul :last-child, ol :last-child { + margin-bottom: 0; +} + +dl { + padding: 0; +} + +dl dt { + font-size: 14px; + font-weight: bold; + font-style: italic; + padding: 0; + margin: 15px 0 5px; +} + +dl dt:first-child { + padding: 0; +} + +dl dt > :first-child { + margin-top: 0; +} + +dl dt > :last-child { + margin-bottom: 0; +} + +dl dd { + margin: 0 0 15px; + padding: 0 15px; +} + +dl dd > :first-child { + margin-top: 0; +} + +dl dd > :last-child { + margin-bottom: 0; +} + +blockquote { + border-left: 4px solid #dddddd; + padding: 0 15px; + color: #777777; +} + +blockquote > :first-child { + margin-top: 0; +} + +blockquote > :last-child { + margin-bottom: 0; +} + +table { + padding: 0; +} +table tr { + border-top: 1px solid #cccccc; + background-color: white; + margin: 0; + padding: 0; +} + +table tr:nth-child(2n) { + background-color: #f8f8f8; +} + +table tr th { + font-weight: bold; + border: 1px solid #cccccc; + text-align: left; + margin: 0; + padding: 6px 13px; +} + +table tr td { + border: 1px solid #cccccc; + text-align: left; + margin: 0; + padding: 6px 13px; +} + +table tr th :first-child, table tr td :first-child { + margin-top: 0; +} + +table tr th :last-child, table tr td :last-child { + margin-bottom: 0; +} + +img { + max-width: 100%; +} + +span.frame { + display: block; + overflow: hidden; +} + +span.frame > span { + border: 1px solid #dddddd; + display: block; + float: left; + overflow: hidden; + margin: 13px 0 0; + padding: 7px; + width: auto; +} + +span.frame span img { + display: block; + float: left; +} + +span.frame span span { + clear: both; + color: #333333; + display: block; + padding: 5px 0 0; +} + +span.align-center { + display: block; + overflow: hidden; + clear: both; +} + +span.align-center > span { + display: block; + overflow: hidden; + margin: 13px auto 0; + text-align: center; +} + +span.align-center span img { + margin: 0 auto; + text-align: center; +} + +span.align-right { + display: block; + overflow: hidden; + clear: both; +} + +span.align-right > span { + display: block; + overflow: hidden; + margin: 13px 0 0; + text-align: right; +} + +span.align-right span img { + margin: 0; + text-align: right; +} + +span.float-left { + display: block; + margin-right: 13px; + overflow: hidden; + float: left; +} + +span.float-left span { + margin: 13px 0 0; +} + +span.float-right { + display: block; + margin-left: 13px; + overflow: hidden; + float: right; +} + +span.float-right > span { + display: block; + overflow: hidden; + margin: 13px auto 0; + text-align: right; +} + +code, tt { + margin: 0 2px; + padding: 0 5px; + white-space: nowrap; + border: 1px solid #eaeaea; + background-color: #f8f8f8; + border-radius: 3px; +} + +pre code { + margin: 0; + padding: 0; + white-space: pre; + border: none; + background: transparent; +} + +.highlight pre { + background-color: #f8f8f8; + border: 1px solid #cccccc; + font-size: 13px; + line-height: 19px; + overflow: auto; + padding: 6px 10px; + border-radius: 3px; +} + +pre { + background-color: #f8f8f8; + border: 1px solid #cccccc; + font-size: 13px; + line-height: 19px; + overflow: auto; + padding: 6px 10px; + border-radius: 3px; +} + +pre code, pre tt { + background-color: transparent; + border: none; +} diff --git a/public/css/docs/syntax.css b/public/css/docs/syntax.css new file mode 100644 index 000000000..bbb14fb7e --- /dev/null +++ b/public/css/docs/syntax.css @@ -0,0 +1,255 @@ +.highlight .err { + color: #a61717; + background-color: #e3d2d2; +} + +.highlight .k { + font-weight: bold; +} + +.highlight .o { + font-weight: bold; +} + +.highlight .cm { + color: #999988; + font-style: italic; +} + +.highlight .cp { + color: #999999; + font-weight: bold; +} + +.highlight .c1 { + color: #999988; + font-style: italic; +} + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; +} + +.highlight .gd { + color: #000000; + background-color: #ffdddd; +} + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; +} + +.highlight .ge { + font-style: italic; +} + +.highlight .gr { + color: #aa0000; +} + +.highlight .gh { + color: #999999; +} + +.highlight .gi { + color: #000000; + background-color: #ddffdd; +} + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; +} + +.highlight .go { + color: #888888; +} + +.highlight .gp { + color: #555555; +} + +.highlight .gs { + font-weight: bold; +} + +.highlight .gu { + color: #800080; + font-weight: bold; +} + +.highlight .gt { + color: #aa0000; +} + +.highlight .kc { + font-weight: bold; +} + +.highlight .kd { + font-weight: bold; +} + +.highlight .kn { + font-weight: bold; +} + +.highlight .kp { + font-weight: bold; +} + +.highlight .kr { + font-weight: bold; +} + +.highlight .kt { + color: #445588; + font-weight: bold; +} + +.highlight .m { + color: #009999; +} + +.highlight .s { + color: #d14; +} + +.highlight .na { + color: #008080; +} + +.highlight .nb { + color: #0086B3; +} + +.highlight .nc { + color: #445588; + font-weight: bold; +} + +.highlight .no { + color: #008080; +} + +.highlight .ni { + color: #800080; +} + +.highlight .ne { + color: #990000; + font-weight: bold; +} + +.highlight .nf { + color: #990000; + font-weight: bold; +} + +.highlight .nn { + color: #555555; +} + +.highlight .nt { + color: #000080; +} + +.highlight .nv { + color: #008080; +} + +.highlight .ow { + font-weight: bold; +} + +.highlight .w { + color: #bbbbbb; +} + +.highlight .mf { + color: #009999; +} + +.highlight .mh { + color: #009999; +} + +.highlight .mi { + color: #009999; +} + +.highlight .mo { + color: #009999; +} + +.highlight .sb { + color: #d14; +} + +.highlight .sc { + color: #d14; +} + +.highlight .sd { + color: #d14; +} + +.highlight .s2 { + color: #d14; +} + +.highlight .se { + color: #d14; +} + +.highlight .sh { + color: #d14; +} + +.highlight .si { + color: #d14; +} + +.highlight .sx { + color: #d14; +} + +.highlight .sr { + color: #009926; +} + +.highlight .s1 { + color: #d14; +} + +.highlight .ss { + color: #990073; +} + +.highlight .bp { + color: #999999; +} + +.highlight .vc { + color: #008080; +} + +.highlight .vg { + color: #008080; +} + +.highlight .vi { + color: #008080; +} + +.highlight .il { + color: #009999; +} + +.highlight .gc { + color: #999; + background-color: #EAF2F5; +} diff --git a/public/docs/addon/apt.md b/public/docs/addon/apt.md new file mode 100644 index 000000000..30345257e --- /dev/null +++ b/public/docs/addon/apt.md @@ -0,0 +1,58 @@ +# Addon Apt + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +apt: + packages: "[ref:strs]" + dist: string +``` + +```yaml +apt: + sources: + - name: string +``` + +```yaml +apt: + sources: + name: string +``` + +```yaml +apt: + sources: + - string one + - string two +``` + +```yaml +apt: + sources: string +``` + +```yaml +apt: "[ref:strs]" + +``` + +```yaml +apt: true + +``` diff --git a/public/docs/addon/artifacts.md b/public/docs/addon/artifacts.md new file mode 100644 index 000000000..b0a601e89 --- /dev/null +++ b/public/docs/addon/artifacts.md @@ -0,0 +1,42 @@ +# Addon Artifacts + + + +## Type + +Any of: + +* Map (Hash) +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +artifacts: + enabled: true + bucket: string + endpoint: string + key: + secret: + paths: "[ref:strs]" + branch: string + log_format: string + target_paths: "[ref:strs]" + debug: true + concurrency: 1 + max_size: 1 + region: string + permissions: string + working_dir: string + cache_control: string +``` + +```yaml +artifacts: true + +``` diff --git a/public/docs/addon/browserstack.md b/public/docs/addon/browserstack.md new file mode 100644 index 000000000..65f9563eb --- /dev/null +++ b/public/docs/addon/browserstack.md @@ -0,0 +1,34 @@ +# Addon Browserstack + + + +## Type + +Any of: + +* Map (Hash) +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +browserstack: + username: string + access_key: + forcelocal: true + only: string + proxyHost: string + proxyPort: string + proxyUser: string + proxyPass: +``` + +```yaml +browserstack: true + +``` diff --git a/public/docs/addon/code_climate.md b/public/docs/addon/code_climate.md new file mode 100644 index 000000000..aa89fd372 --- /dev/null +++ b/public/docs/addon/code_climate.md @@ -0,0 +1,33 @@ +# Addon Code Climate + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +code_climate: + repo_token: +``` + +```yaml +code_climate: + +``` + +```yaml +code_climate: true + +``` diff --git a/public/docs/addon/coverity_scan.md b/public/docs/addon/coverity_scan.md new file mode 100644 index 000000000..ed779c65a --- /dev/null +++ b/public/docs/addon/coverity_scan.md @@ -0,0 +1,44 @@ +# Addon Coverity Scan + + + +## Type + +Any of: + +* Map (Hash) +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +coverity_scan: + build_script_url: string + branch_pattern: string + notification_email: string + build_command: string + build_command_prepend: string +``` + +```yaml +coverity_scan: + project: + name: string + version: string + description: string +``` + +```yaml +coverity_scan: + project: string +``` + +```yaml +coverity_scan: true + +``` diff --git a/public/docs/addon/homebrew.md b/public/docs/addon/homebrew.md new file mode 100644 index 000000000..8146f99cb --- /dev/null +++ b/public/docs/addon/homebrew.md @@ -0,0 +1,37 @@ +# Addon Homebrew + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +homebrew: + update: true + packages: "[ref:strs]" + casks: "[ref:strs]" + taps: "[ref:strs]" + brewfile: string +``` + +```yaml +homebrew: "[ref:strs]" + +``` + +```yaml +homebrew: true + +``` diff --git a/public/docs/addon/jwts.md b/public/docs/addon/jwts.md new file mode 100644 index 000000000..f5600b321 --- /dev/null +++ b/public/docs/addon/jwts.md @@ -0,0 +1,13 @@ +# JSON Web Tokens + + + +## Type + + + +## Flags + +None. + + diff --git a/public/docs/addon/sauce_connect.md b/public/docs/addon/sauce_connect.md new file mode 100644 index 000000000..bb479daf2 --- /dev/null +++ b/public/docs/addon/sauce_connect.md @@ -0,0 +1,32 @@ +# Addon Sauce Connect + + + +## Type + +Any of: + +* Map (Hash) +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +sauce_connect: + enabled: true + username: + access_key: + direct_domains: string + tunnel_domains: string + no_ssl_bump_domains: string +``` + +```yaml +sauce_connect: true + +``` diff --git a/public/docs/addon/snaps.md b/public/docs/addon/snaps.md new file mode 100644 index 000000000..35399a60b --- /dev/null +++ b/public/docs/addon/snaps.md @@ -0,0 +1,44 @@ +# Addon Snaps + + + +## Type + +Any of: + +* Sequence (Array) +* Map (Hash) +* Sequence (Array) +* String + +## Flags + +None. + + +## Examples + +```yaml +snaps: +- name: string + classic: true + channel: string +``` + +```yaml +snaps: + name: string + classic: true + channel: string +``` + +```yaml +snaps: +- string one +- string two +``` + +```yaml +snaps: string + +``` diff --git a/public/docs/deploy/anynines.md b/public/docs/deploy/anynines.md new file mode 100644 index 000000000..afffb924c --- /dev/null +++ b/public/docs/deploy/anynines.md @@ -0,0 +1,35 @@ +# Deploy Anynines + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: anynines + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + space: string +``` + +```yaml +deploy: anynines + +``` diff --git a/public/docs/deploy/app.md b/public/docs/deploy/app.md new file mode 100644 index 000000000..ba3d10a58 --- /dev/null +++ b/public/docs/deploy/app.md @@ -0,0 +1,27 @@ +# Deploy App + + + +## Type + +Any of: + +* Map (Hash) +* String + +## Flags + +None. + + +## Examples + +```yaml +app: + ".*": string +``` + +```yaml +app: string + +``` diff --git a/public/docs/deploy/appfog.md b/public/docs/deploy/appfog.md new file mode 100644 index 000000000..51ab3e73a --- /dev/null +++ b/public/docs/deploy/appfog.md @@ -0,0 +1,63 @@ +# Deploy Appfog + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: appfog + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + api_key: + address: "[ref:strs]" + metadata: string + after_deploy: "[ref:strs]" + app: string +``` + +```yaml +deploy: + provider: appfog + email: + ".*": +``` + +```yaml +deploy: + provider: appfog + email: +``` + +```yaml +deploy: + provider: appfog + password: + ".*": +``` + +```yaml +deploy: + provider: appfog + password: +``` + +```yaml +deploy: appfog + +``` diff --git a/public/docs/deploy/atlas.md b/public/docs/deploy/atlas.md new file mode 100644 index 000000000..2ccb0b487 --- /dev/null +++ b/public/docs/deploy/atlas.md @@ -0,0 +1,40 @@ +# Deploy Atlas + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: atlas + on: {} + allow_failure: true + skip_cleanup: true + edge: true + token: + app: string + exclude: "[ref:strs]" + include: "[ref:strs]" + address: string + vcs: true + metadata: "[ref:strs]" + debug: true + version: string +``` + +```yaml +deploy: atlas + +``` diff --git a/public/docs/deploy/azure_web_apps.md b/public/docs/deploy/azure_web_apps.md new file mode 100644 index 000000000..fcf33789d --- /dev/null +++ b/public/docs/deploy/azure_web_apps.md @@ -0,0 +1,36 @@ +# Deploy Azure Web Apps + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: azure_web_apps + on: {} + allow_failure: true + skip_cleanup: true + edge: true + site: string + slot: string + username: + password: + verbose: true +``` + +```yaml +deploy: azure_web_apps + +``` diff --git a/public/docs/deploy/bintray.md b/public/docs/deploy/bintray.md new file mode 100644 index 000000000..8d647a113 --- /dev/null +++ b/public/docs/deploy/bintray.md @@ -0,0 +1,36 @@ +# Deploy Bintray + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: bintray + on: {} + allow_failure: true + skip_cleanup: true + edge: true + file: string + user: + key: + passphrase: + dry_run: true +``` + +```yaml +deploy: bintray + +``` diff --git a/public/docs/deploy/bitballoon.md b/public/docs/deploy/bitballoon.md new file mode 100644 index 000000000..5b5a75aeb --- /dev/null +++ b/public/docs/deploy/bitballoon.md @@ -0,0 +1,34 @@ +# Deploy Bitballoon + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: bitballoon + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_token: + site_id: string + local_dir: string +``` + +```yaml +deploy: bitballoon + +``` diff --git a/public/docs/deploy/bluemixcf.md b/public/docs/deploy/bluemixcf.md new file mode 100644 index 000000000..452274326 --- /dev/null +++ b/public/docs/deploy/bluemixcf.md @@ -0,0 +1,39 @@ +# Deploy Bluemixcf + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: bluemixcf + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + api: string + space: string + region: string + manifest: string + skip_ssl_validation: true +``` + +```yaml +deploy: bluemixcf + +``` diff --git a/public/docs/deploy/boxfuse.md b/public/docs/deploy/boxfuse.md new file mode 100644 index 000000000..8fe35b0d0 --- /dev/null +++ b/public/docs/deploy/boxfuse.md @@ -0,0 +1,40 @@ +# Deploy Boxfuse + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: boxfuse + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + secret: + configfile: string + payload: string + app: string + version: string + env: string + image: string + extra_args: string +``` + +```yaml +deploy: boxfuse + +``` diff --git a/public/docs/deploy/branches.md b/public/docs/deploy/branches.md new file mode 100644 index 000000000..4397d6523 --- /dev/null +++ b/public/docs/deploy/branches.md @@ -0,0 +1,22 @@ +# Deploy Branches + + + +## Type + +Any of: + +* Sequence (Array) +* Map (Hash) + +## Flags + +None. + + +## Examples + +```yaml +branch: {} + +``` diff --git a/public/docs/deploy/catalyze.md b/public/docs/deploy/catalyze.md new file mode 100644 index 000000000..bd7ac5dd4 --- /dev/null +++ b/public/docs/deploy/catalyze.md @@ -0,0 +1,33 @@ +# Deploy Catalyze + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: catalyze + on: {} + allow_failure: true + skip_cleanup: true + edge: true + target: string + path: string +``` + +```yaml +deploy: catalyze + +``` diff --git a/public/docs/deploy/chef_supermarket.md b/public/docs/deploy/chef_supermarket.md new file mode 100644 index 000000000..b7168a67a --- /dev/null +++ b/public/docs/deploy/chef_supermarket.md @@ -0,0 +1,34 @@ +# Deploy Chef Supermarket + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: chef_supermarket + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user_id: + client_key: + cookbook_category: string +``` + +```yaml +deploy: chef_supermarket + +``` diff --git a/public/docs/deploy/cloud66.md b/public/docs/deploy/cloud66.md new file mode 100644 index 000000000..070191ddf --- /dev/null +++ b/public/docs/deploy/cloud66.md @@ -0,0 +1,32 @@ +# Deploy Cloud66 + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: cloud66 + on: {} + allow_failure: true + skip_cleanup: true + edge: true + redeployment_hook: string +``` + +```yaml +deploy: cloud66 + +``` diff --git a/public/docs/deploy/cloudcontrol.md b/public/docs/deploy/cloudcontrol.md new file mode 100644 index 000000000..22b7126e6 --- /dev/null +++ b/public/docs/deploy/cloudcontrol.md @@ -0,0 +1,34 @@ +# Deploy Cloudcontrol + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: cloudcontrol + on: {} + allow_failure: true + skip_cleanup: true + edge: true + email: + password: + deployment: string +``` + +```yaml +deploy: cloudcontrol + +``` diff --git a/public/docs/deploy/cloudfiles.md b/public/docs/deploy/cloudfiles.md new file mode 100644 index 000000000..0b199dbc9 --- /dev/null +++ b/public/docs/deploy/cloudfiles.md @@ -0,0 +1,36 @@ +# Deploy Cloudfiles + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: cloudfiles + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + api_key: + region: string + container: string + dot_match: true +``` + +```yaml +deploy: cloudfiles + +``` diff --git a/public/docs/deploy/cloudfoundry.md b/public/docs/deploy/cloudfoundry.md new file mode 100644 index 000000000..769ee3f25 --- /dev/null +++ b/public/docs/deploy/cloudfoundry.md @@ -0,0 +1,39 @@ +# Deploy Cloudfoundry + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: cloudfoundry + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + api: string + space: string + key: string + manifest: string + skip_ssl_validation: true +``` + +```yaml +deploy: cloudfoundry + +``` diff --git a/public/docs/deploy/codedeploy.md b/public/docs/deploy/codedeploy.md new file mode 100644 index 000000000..01a1ed641 --- /dev/null +++ b/public/docs/deploy/codedeploy.md @@ -0,0 +1,42 @@ +# Deploy Codedeploy + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: codedeploy + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + application: string + deployment_group: string + revision_type: s3 + commit_id: string + repository: string + region: string + wait_until_deployed: true + bucket: string + key: string +``` + +```yaml +deploy: codedeploy + +``` diff --git a/public/docs/deploy/conditions.md b/public/docs/deploy/conditions.md new file mode 100644 index 000000000..9ecdae8cf --- /dev/null +++ b/public/docs/deploy/conditions.md @@ -0,0 +1,30 @@ +# Deploy Conditions + + + +## Type + +Any of: + +* +* Any of: + +* Sequence (Array) +* Map (Hash) + +## Flags + +None. + + +## Examples + +```yaml +on: + +``` + +```yaml +on: {} + +``` diff --git a/public/docs/deploy/deis.md b/public/docs/deploy/deis.md new file mode 100644 index 000000000..4dae10a7d --- /dev/null +++ b/public/docs/deploy/deis.md @@ -0,0 +1,36 @@ +# Deploy Deis + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: deis + on: {} + allow_failure: true + skip_cleanup: true + edge: true + controller: string + username: + password: + app: string + cli_version: string +``` + +```yaml +deploy: deis + +``` diff --git a/public/docs/deploy/divshot.md b/public/docs/deploy/divshot.md new file mode 100644 index 000000000..3b5cdd5f1 --- /dev/null +++ b/public/docs/deploy/divshot.md @@ -0,0 +1,33 @@ +# Deploy Divshot + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: divshot + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + environment: string +``` + +```yaml +deploy: divshot + +``` diff --git a/public/docs/deploy/edge.md b/public/docs/deploy/edge.md new file mode 100644 index 000000000..f9a0fbc28 --- /dev/null +++ b/public/docs/deploy/edge.md @@ -0,0 +1,29 @@ +# Deploy Edge + + + +## Type + +Any of: + +* Map (Hash) +* Boolean + +## Flags + +* Edge: + + +## Examples + +```yaml +edge: + enabled: true + source: string + branch: string +``` + +```yaml +edge: true + +``` diff --git a/public/docs/deploy/elasticbeanstalk.md b/public/docs/deploy/elasticbeanstalk.md new file mode 100644 index 000000000..85bb8c2a5 --- /dev/null +++ b/public/docs/deploy/elasticbeanstalk.md @@ -0,0 +1,40 @@ +# Deploy Elasticbeanstalk + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: elasticbeanstalk + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + securet_access_key: + region: string + app: string + env: string + zip_file: string + bucket_name: string + bucket_path: string + only_create_app_version: true +``` + +```yaml +deploy: elasticbeanstalk + +``` diff --git a/public/docs/deploy/engineyard.md b/public/docs/deploy/engineyard.md new file mode 100644 index 000000000..30b81c43f --- /dev/null +++ b/public/docs/deploy/engineyard.md @@ -0,0 +1,37 @@ +# Deploy Engineyard + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: engineyard + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + api_key: + app: string + environment: string + migrate: string +``` + +```yaml +deploy: engineyard + +``` diff --git a/public/docs/deploy/firebase.md b/public/docs/deploy/firebase.md new file mode 100644 index 000000000..5017aacbc --- /dev/null +++ b/public/docs/deploy/firebase.md @@ -0,0 +1,34 @@ +# Deploy Firebase + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: firebase + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + token: + message: string +``` + +```yaml +deploy: firebase + +``` diff --git a/public/docs/deploy/gae.md b/public/docs/deploy/gae.md new file mode 100644 index 000000000..ebadbbd3e --- /dev/null +++ b/public/docs/deploy/gae.md @@ -0,0 +1,38 @@ +# Deploy Gae + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: gae + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + keyfile: string + config: string + version: string + no_promote: true + no_stop_previous_version: true + verbosity: string +``` + +```yaml +deploy: gae + +``` diff --git a/public/docs/deploy/gcs.md b/public/docs/deploy/gcs.md new file mode 100644 index 000000000..f58f6cc98 --- /dev/null +++ b/public/docs/deploy/gcs.md @@ -0,0 +1,40 @@ +# Deploy Gcs + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: gcs + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + bucket: string + upload_dir: string + local_dir: string + dot_match: true + acl: string + cache_control: string + detect_encoding: true +``` + +```yaml +deploy: gcs + +``` diff --git a/public/docs/deploy/hackage.md b/public/docs/deploy/hackage.md new file mode 100644 index 000000000..9ccc69c63 --- /dev/null +++ b/public/docs/deploy/hackage.md @@ -0,0 +1,33 @@ +# Deploy Hackage + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: hackage + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: +``` + +```yaml +deploy: hackage + +``` diff --git a/public/docs/deploy/heroku.md b/public/docs/deploy/heroku.md new file mode 100644 index 000000000..72fb70206 --- /dev/null +++ b/public/docs/deploy/heroku.md @@ -0,0 +1,36 @@ +# Deploy Heroku + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: heroku + on: {} + allow_failure: true + skip_cleanup: true + edge: true + strategy: api + buildpack: string + app: string + api_key: + run: "[ref:strs]" +``` + +```yaml +deploy: heroku + +``` diff --git a/public/docs/deploy/lambda.md b/public/docs/deploy/lambda.md new file mode 100644 index 000000000..53da5efc1 --- /dev/null +++ b/public/docs/deploy/lambda.md @@ -0,0 +1,51 @@ +# Deploy Lambda + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: lambda + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + region: string + function_name: string + role: string + handler_name: string + module_name: string + zip: string + description: string + timeout: string + memory_size: string + runtime: string + environment_variables: + security_group_ids: "[ref:strs]" + subnet_ids: "[ref:strs]" + dead_letter_config: string + kms_key_arn: string + tracing_mode: Active + publish: true + function_tags: +``` + +```yaml +deploy: lambda + +``` diff --git a/public/docs/deploy/launchpad.md b/public/docs/deploy/launchpad.md new file mode 100644 index 000000000..2ac14832f --- /dev/null +++ b/public/docs/deploy/launchpad.md @@ -0,0 +1,34 @@ +# Deploy Launchpad + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: launchpad + slug: string + oauth_token: + oauth_token_secret: + on: {} + allow_failure: true + skip_cleanup: true + edge: true +``` + +```yaml +deploy: launchpad + +``` diff --git a/public/docs/deploy/modulus.md b/public/docs/deploy/modulus.md new file mode 100644 index 000000000..ee9033c6d --- /dev/null +++ b/public/docs/deploy/modulus.md @@ -0,0 +1,33 @@ +# Deploy Modulus + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: modulus + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + project_name: string +``` + +```yaml +deploy: modulus + +``` diff --git a/public/docs/deploy/npm.md b/public/docs/deploy/npm.md new file mode 100644 index 000000000..f433a6a30 --- /dev/null +++ b/public/docs/deploy/npm.md @@ -0,0 +1,33 @@ +# Deploy Npm + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: npm + on: {} + allow_failure: true + skip_cleanup: true + edge: true + email: + api_key: +``` + +```yaml +deploy: npm + +``` diff --git a/public/docs/deploy/openshift.md b/public/docs/deploy/openshift.md new file mode 100644 index 000000000..e4fe06280 --- /dev/null +++ b/public/docs/deploy/openshift.md @@ -0,0 +1,36 @@ +# Deploy Openshift + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: openshift + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + domain: string + app: string + deployment_branch: string +``` + +```yaml +deploy: openshift + +``` diff --git a/public/docs/deploy/opsworks.md b/public/docs/deploy/opsworks.md new file mode 100644 index 000000000..6d047e996 --- /dev/null +++ b/public/docs/deploy/opsworks.md @@ -0,0 +1,39 @@ +# Deploy Opsworks + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: opsworks + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + app_id: string + instance_ids: string + layer_ids: string + migrate: true + wait_until_deployed: string + custom_json: string +``` + +```yaml +deploy: opsworks + +``` diff --git a/public/docs/deploy/packagecloud.md b/public/docs/deploy/packagecloud.md new file mode 100644 index 000000000..6c83ad91c --- /dev/null +++ b/public/docs/deploy/packagecloud.md @@ -0,0 +1,38 @@ +# Deploy Packagecloud + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: packagecloud + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + token: + repository: string + local_dir: string + dist: string + package_glob: string + force: true +``` + +```yaml +deploy: packagecloud + +``` diff --git a/public/docs/deploy/pages.md b/public/docs/deploy/pages.md new file mode 100644 index 000000000..3100f7009 --- /dev/null +++ b/public/docs/deploy/pages.md @@ -0,0 +1,45 @@ +# Deploy Pages + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: pages + on: {} + allow_failure: true + skip_cleanup: true + edge: true + github_token: + repo: string + target_branch: string + local_dir: string + fqdn: string + project_name: string + email: string + name: string + github_url: string + keep_history: true + verbose: true + allow_empty_commit: true + committer_from_gh: true + deployment_file: true +``` + +```yaml +deploy: pages + +``` diff --git a/public/docs/deploy/providers.md b/public/docs/deploy/providers.md new file mode 100644 index 000000000..dfedfe1ec --- /dev/null +++ b/public/docs/deploy/providers.md @@ -0,0 +1,1032 @@ +# Deploy Providers + + + +## Type + +Any of: + +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: anynines + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + space: string +``` + +```yaml +deploy: anynines + +``` + +```yaml +deploy: + provider: appfog + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + api_key: + address: "[ref:strs]" + metadata: string + after_deploy: "[ref:strs]" + app: string +``` + +```yaml +deploy: + provider: appfog + email: + ".*": +``` + +```yaml +deploy: + provider: appfog + email: +``` + +```yaml +deploy: + provider: appfog + password: + ".*": +``` + +```yaml +deploy: + provider: appfog + password: +``` + +```yaml +deploy: appfog + +``` + +```yaml +deploy: + provider: atlas + on: {} + allow_failure: true + skip_cleanup: true + edge: true + token: + app: string + exclude: "[ref:strs]" + include: "[ref:strs]" + address: string + vcs: true + metadata: "[ref:strs]" + debug: true + version: string +``` + +```yaml +deploy: atlas + +``` + +```yaml +deploy: + provider: azure_web_apps + on: {} + allow_failure: true + skip_cleanup: true + edge: true + site: string + slot: string + username: + password: + verbose: true +``` + +```yaml +deploy: azure_web_apps + +``` + +```yaml +deploy: + provider: bintray + on: {} + allow_failure: true + skip_cleanup: true + edge: true + file: string + user: + key: + passphrase: + dry_run: true +``` + +```yaml +deploy: bintray + +``` + +```yaml +deploy: + provider: bitballoon + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_token: + site_id: string + local_dir: string +``` + +```yaml +deploy: bitballoon + +``` + +```yaml +deploy: + provider: bluemixcf + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + api: string + space: string + region: string + manifest: string + skip_ssl_validation: true +``` + +```yaml +deploy: bluemixcf + +``` + +```yaml +deploy: + provider: boxfuse + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + secret: + configfile: string + payload: string + app: string + version: string + env: string + image: string + extra_args: string +``` + +```yaml +deploy: boxfuse + +``` + +```yaml +deploy: + provider: catalyze + on: {} + allow_failure: true + skip_cleanup: true + edge: true + target: string + path: string +``` + +```yaml +deploy: catalyze + +``` + +```yaml +deploy: + provider: chef_supermarket + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user_id: + client_key: + cookbook_category: string +``` + +```yaml +deploy: chef_supermarket + +``` + +```yaml +deploy: + provider: cloud66 + on: {} + allow_failure: true + skip_cleanup: true + edge: true + redeployment_hook: string +``` + +```yaml +deploy: cloud66 + +``` + +```yaml +deploy: + provider: cloudcontrol + on: {} + allow_failure: true + skip_cleanup: true + edge: true + email: + password: + deployment: string +``` + +```yaml +deploy: cloudcontrol + +``` + +```yaml +deploy: + provider: cloudfiles + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + api_key: + region: string + container: string + dot_match: true +``` + +```yaml +deploy: cloudfiles + +``` + +```yaml +deploy: + provider: cloudfoundry + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + api: string + space: string + key: string + manifest: string + skip_ssl_validation: true +``` + +```yaml +deploy: cloudfoundry + +``` + +```yaml +deploy: + provider: codedeploy + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + application: string + deployment_group: string + revision_type: s3 + commit_id: string + repository: string + region: string + wait_until_deployed: true + bucket: string + key: string +``` + +```yaml +deploy: codedeploy + +``` + +```yaml +deploy: + provider: deis + on: {} + allow_failure: true + skip_cleanup: true + edge: true + controller: string + username: + password: + app: string + cli_version: string +``` + +```yaml +deploy: deis + +``` + +```yaml +deploy: + provider: divshot + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + environment: string +``` + +```yaml +deploy: divshot + +``` + +```yaml +deploy: + provider: elasticbeanstalk + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + securet_access_key: + region: string + app: string + env: string + zip_file: string + bucket_name: string + bucket_path: string + only_create_app_version: true +``` + +```yaml +deploy: elasticbeanstalk + +``` + +```yaml +deploy: + provider: engineyard + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + api_key: + app: string + environment: string + migrate: string +``` + +```yaml +deploy: engineyard + +``` + +```yaml +deploy: + provider: firebase + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + token: + message: string +``` + +```yaml +deploy: firebase + +``` + +```yaml +deploy: + provider: gae + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + keyfile: string + config: string + version: string + no_promote: true + no_stop_previous_version: true + verbosity: string +``` + +```yaml +deploy: gae + +``` + +```yaml +deploy: + provider: gcs + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + bucket: string + upload_dir: string + local_dir: string + dot_match: true + acl: string + cache_control: string + detect_encoding: true +``` + +```yaml +deploy: gcs + +``` + +```yaml +deploy: + provider: hackage + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: +``` + +```yaml +deploy: hackage + +``` + +```yaml +deploy: + provider: heroku + on: {} + allow_failure: true + skip_cleanup: true + edge: true + strategy: api + buildpack: string + app: string + api_key: + run: "[ref:strs]" +``` + +```yaml +deploy: heroku + +``` + +```yaml +deploy: + provider: lambda + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + region: string + function_name: string + role: string + handler_name: string + module_name: string + zip: string + description: string + timeout: string + memory_size: string + runtime: string + environment_variables: + security_group_ids: "[ref:strs]" + subnet_ids: "[ref:strs]" + dead_letter_config: string + kms_key_arn: string + tracing_mode: Active + publish: true + function_tags: +``` + +```yaml +deploy: lambda + +``` + +```yaml +deploy: + provider: launchpad + slug: string + oauth_token: + oauth_token_secret: + on: {} + allow_failure: true + skip_cleanup: true + edge: true +``` + +```yaml +deploy: launchpad + +``` + +```yaml +deploy: + provider: modulus + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + project_name: string +``` + +```yaml +deploy: modulus + +``` + +```yaml +deploy: + provider: npm + on: {} + allow_failure: true + skip_cleanup: true + edge: true + email: + api_key: +``` + +```yaml +deploy: npm + +``` + +```yaml +deploy: + provider: openshift + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + domain: string + app: string + deployment_branch: string +``` + +```yaml +deploy: openshift + +``` + +```yaml +deploy: + provider: opsworks + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + app_id: string + instance_ids: string + layer_ids: string + migrate: true + wait_until_deployed: string + custom_json: string +``` + +```yaml +deploy: opsworks + +``` + +```yaml +deploy: + provider: packagecloud + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + token: + repository: string + local_dir: string + dist: string + package_glob: string + force: true +``` + +```yaml +deploy: packagecloud + +``` + +```yaml +deploy: + provider: pages + on: {} + allow_failure: true + skip_cleanup: true + edge: true + github_token: + repo: string + target_branch: string + local_dir: string + fqdn: string + project_name: string + email: string + name: string + github_url: string + keep_history: true + verbose: true + allow_empty_commit: true + committer_from_gh: true + deployment_file: true +``` + +```yaml +deploy: pages + +``` + +```yaml +deploy: + provider: puppetforge + user: + password: + on: {} + allow_failure: true + skip_cleanup: true + edge: true + url: string +``` + +```yaml +deploy: puppetforge + +``` + +```yaml +deploy: + provider: pypi + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + api_key: + server: string + distributions: string + docs_dir: string +``` + +```yaml +deploy: pypi + +``` + +```yaml +deploy: + provider: releases + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + api_key: + repo: string + file: "[ref:strs]" + file_glob: string + overwrite: string + release_number: string + prerelease: true +``` + +```yaml +deploy: releases + +``` + +```yaml +deploy: + provider: rubygems + on: {} + allow_failure: true + skip_cleanup: true + edge: true + gem: string + file: string + gemspec: string + api_key: +``` + +```yaml +deploy: rubygems + +``` + +```yaml +deploy: + provider: s3 + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + bucket: string + region: string + upload_dir: string + storage_class: string + local_dir: string + detect_encoding: true + cache_control: string + expires: string + acl: string + dot_match: true + index_document_suffix: string + default_text_charset: string + server_side_encryption: true +``` + +```yaml +deploy: s3 + +``` + +```yaml +deploy: + provider: scalingo + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + api_key: + remote: string + branch: string + app: string +``` + +```yaml +deploy: scalingo + +``` + +```yaml +deploy: + provider: script + on: {} + allow_failure: true + skip_cleanup: true + edge: true + script: string +``` + +```yaml +deploy: script + +``` + +```yaml +deploy: + provider: surge + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + domain: string +``` + +```yaml +deploy: surge + +``` + +```yaml +deploy: + provider: testfairy + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + app_file: string + symbols_file: string + testers_groups: string + notify: true + auto_update: true + video_quality: string + screenshot_quality: string + screenshot_interval: string + max_duration: string + advanced_options: string + data_only_wifi: true + record_on_backgroup: true + video: true + icon_watermark: true + metrics: string +``` + +```yaml +deploy: testfairy + +``` diff --git a/public/docs/deploy/puppetforge.md b/public/docs/deploy/puppetforge.md new file mode 100644 index 000000000..33055861a --- /dev/null +++ b/public/docs/deploy/puppetforge.md @@ -0,0 +1,34 @@ +# Deploy Puppetforge + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: puppetforge + user: + password: + on: {} + allow_failure: true + skip_cleanup: true + edge: true + url: string +``` + +```yaml +deploy: puppetforge + +``` diff --git a/public/docs/deploy/pypi.md b/public/docs/deploy/pypi.md new file mode 100644 index 000000000..b51a7ede6 --- /dev/null +++ b/public/docs/deploy/pypi.md @@ -0,0 +1,37 @@ +# Deploy Pypi + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: pypi + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + api_key: + server: string + distributions: string + docs_dir: string +``` + +```yaml +deploy: pypi + +``` diff --git a/public/docs/deploy/releases.md b/public/docs/deploy/releases.md new file mode 100644 index 000000000..86511a72a --- /dev/null +++ b/public/docs/deploy/releases.md @@ -0,0 +1,40 @@ +# Deploy Releases + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: releases + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + api_key: + repo: string + file: "[ref:strs]" + file_glob: string + overwrite: string + release_number: string + prerelease: true +``` + +```yaml +deploy: releases + +``` diff --git a/public/docs/deploy/rubygems.md b/public/docs/deploy/rubygems.md new file mode 100644 index 000000000..3e2e20a93 --- /dev/null +++ b/public/docs/deploy/rubygems.md @@ -0,0 +1,35 @@ +# Deploy Rubygems + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: rubygems + on: {} + allow_failure: true + skip_cleanup: true + edge: true + gem: string + file: string + gemspec: string + api_key: +``` + +```yaml +deploy: rubygems + +``` diff --git a/public/docs/deploy/s3.md b/public/docs/deploy/s3.md new file mode 100644 index 000000000..584a1ca76 --- /dev/null +++ b/public/docs/deploy/s3.md @@ -0,0 +1,46 @@ +# Deploy S3 + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: s3 + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + bucket: string + region: string + upload_dir: string + storage_class: string + local_dir: string + detect_encoding: true + cache_control: string + expires: string + acl: string + dot_match: true + index_document_suffix: string + default_text_charset: string + server_side_encryption: true +``` + +```yaml +deploy: s3 + +``` diff --git a/public/docs/deploy/scalingo.md b/public/docs/deploy/scalingo.md new file mode 100644 index 000000000..9f0138444 --- /dev/null +++ b/public/docs/deploy/scalingo.md @@ -0,0 +1,37 @@ +# Deploy Scalingo + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: scalingo + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + api_key: + remote: string + branch: string + app: string +``` + +```yaml +deploy: scalingo + +``` diff --git a/public/docs/deploy/script.md b/public/docs/deploy/script.md new file mode 100644 index 000000000..cb6dd90e9 --- /dev/null +++ b/public/docs/deploy/script.md @@ -0,0 +1,32 @@ +# Deploy Script + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: script + on: {} + allow_failure: true + skip_cleanup: true + edge: true + script: string +``` + +```yaml +deploy: script + +``` diff --git a/public/docs/deploy/surge.md b/public/docs/deploy/surge.md new file mode 100644 index 000000000..b3f3f96cd --- /dev/null +++ b/public/docs/deploy/surge.md @@ -0,0 +1,33 @@ +# Deploy Surge + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: surge + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + domain: string +``` + +```yaml +deploy: surge + +``` diff --git a/public/docs/deploy/testfairy.md b/public/docs/deploy/testfairy.md new file mode 100644 index 000000000..0c7f1a339 --- /dev/null +++ b/public/docs/deploy/testfairy.md @@ -0,0 +1,47 @@ +# Deploy Testfairy + + + +## Type + +Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: + provider: testfairy + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + app_file: string + symbols_file: string + testers_groups: string + notify: true + auto_update: true + video_quality: string + screenshot_quality: string + screenshot_interval: string + max_duration: string + advanced_options: string + data_only_wifi: true + record_on_backgroup: true + video: true + icon_watermark: true + metrics: string +``` + +```yaml +deploy: testfairy + +``` diff --git a/public/docs/index.md b/public/docs/index.md new file mode 100644 index 000000000..9dabc6c58 --- /dev/null +++ b/public/docs/index.md @@ -0,0 +1,127 @@ +* [Addons](/v1/docs/type/addons) +* [Architecture](/v1/docs/type/arch) +* [Architectures](/v1/docs/type/archs) +* [Branches](/v1/docs/type/branches) +* [Cache](/v1/docs/type/cache) +* [Compilers](/v1/docs/type/compilers) +* [Conditions](/v1/docs/type/conditions) +* [Deploys](/v1/docs/type/deploys) +* [Dist](/v1/docs/type/dist) +* [Env](/v1/docs/type/env) +* [Env Var](/v1/docs/type/env_var) +* [Env Vars](/v1/docs/type/env_vars) +* [Git](/v1/docs/type/git) +* [Group](/v1/docs/type/group) +* [Import](/v1/docs/type/import) +* [Imports](/v1/docs/type/imports) +* [Job](/v1/docs/type/job) +* [Languages](/v1/docs/type/languages) +* [Matrix](/v1/docs/type/matrix) +* [Matrix Entries](/v1/docs/type/matrix_entries) +* [Matrix Entry](/v1/docs/type/matrix_entry) +* [Notifications](/v1/docs/type/notifications) +* [Os](/v1/docs/type/os) +* [Oss](/v1/docs/type/oss) +* [Service](/v1/docs/type/service) +* [Services](/v1/docs/type/services) +* [Stack](/v1/docs/type/stack) +* [Stage](/v1/docs/type/stage) +* [Stages](/v1/docs/type/stages) +* [Sudo](/v1/docs/type/sudo) +* [Version](/v1/docs/type/version) +* [Addon Apt](/v1/docs/addon/apt) +* [Addon Artifacts](/v1/docs/addon/artifacts) +* [Addon Browserstack](/v1/docs/addon/browserstack) +* [Addon Code Climate](/v1/docs/addon/code_climate) +* [Addon Coverity Scan](/v1/docs/addon/coverity_scan) +* [Addon Homebrew](/v1/docs/addon/homebrew) +* [JSON Web Tokens](/v1/docs/addon/jwts) +* [Addon Sauce Connect](/v1/docs/addon/sauce_connect) +* [Addon Snaps](/v1/docs/addon/snaps) +* [Deploy Anynines](/v1/docs/deploy/anynines) +* [Deploy App](/v1/docs/deploy/app) +* [Deploy Appfog](/v1/docs/deploy/appfog) +* [Deploy Atlas](/v1/docs/deploy/atlas) +* [Deploy Azure Web Apps](/v1/docs/deploy/azure_web_apps) +* [Deploy Bintray](/v1/docs/deploy/bintray) +* [Deploy Bitballoon](/v1/docs/deploy/bitballoon) +* [Deploy Bluemixcf](/v1/docs/deploy/bluemixcf) +* [Deploy Boxfuse](/v1/docs/deploy/boxfuse) +* [Deploy Branches](/v1/docs/deploy/branches) +* [Deploy Catalyze](/v1/docs/deploy/catalyze) +* [Deploy Chef Supermarket](/v1/docs/deploy/chef_supermarket) +* [Deploy Cloud66](/v1/docs/deploy/cloud66) +* [Deploy Cloudcontrol](/v1/docs/deploy/cloudcontrol) +* [Deploy Cloudfiles](/v1/docs/deploy/cloudfiles) +* [Deploy Cloudfoundry](/v1/docs/deploy/cloudfoundry) +* [Deploy Codedeploy](/v1/docs/deploy/codedeploy) +* [Deploy Conditions](/v1/docs/deploy/conditions) +* [Deploy Deis](/v1/docs/deploy/deis) +* [Deploy Divshot](/v1/docs/deploy/divshot) +* [Deploy Edge](/v1/docs/deploy/edge) +* [Deploy Elasticbeanstalk](/v1/docs/deploy/elasticbeanstalk) +* [Deploy Engineyard](/v1/docs/deploy/engineyard) +* [Deploy Firebase](/v1/docs/deploy/firebase) +* [Deploy Gae](/v1/docs/deploy/gae) +* [Deploy Gcs](/v1/docs/deploy/gcs) +* [Deploy Hackage](/v1/docs/deploy/hackage) +* [Deploy Heroku](/v1/docs/deploy/heroku) +* [Deploy Lambda](/v1/docs/deploy/lambda) +* [Deploy Launchpad](/v1/docs/deploy/launchpad) +* [Deploy Modulus](/v1/docs/deploy/modulus) +* [Deploy Npm](/v1/docs/deploy/npm) +* [Deploy Openshift](/v1/docs/deploy/openshift) +* [Deploy Opsworks](/v1/docs/deploy/opsworks) +* [Deploy Packagecloud](/v1/docs/deploy/packagecloud) +* [Deploy Pages](/v1/docs/deploy/pages) +* [Deploy Providers](/v1/docs/deploy/providers) +* [Deploy Puppetforge](/v1/docs/deploy/puppetforge) +* [Deploy Pypi](/v1/docs/deploy/pypi) +* [Deploy Releases](/v1/docs/deploy/releases) +* [Deploy Rubygems](/v1/docs/deploy/rubygems) +* [Deploy S3](/v1/docs/deploy/s3) +* [Deploy Scalingo](/v1/docs/deploy/scalingo) +* [Deploy Script](/v1/docs/deploy/script) +* [Deploy Surge](/v1/docs/deploy/surge) +* [Deploy Testfairy](/v1/docs/deploy/testfairy) +* [Language Android](/v1/docs/language/android) +* [Language C](/v1/docs/language/c) +* [Language Clojure](/v1/docs/language/clojure) +* [Language Cpp](/v1/docs/language/cpp) +* [Language Crystal](/v1/docs/language/crystal) +* [Language Csharp](/v1/docs/language/csharp) +* [Language D](/v1/docs/language/d) +* [Language Dart](/v1/docs/language/dart) +* [Language Elixir](/v1/docs/language/elixir) +* [Language Elm](/v1/docs/language/elm) +* [Language Erlang](/v1/docs/language/erlang) +* [Language Go](/v1/docs/language/go) +* [Language Groovy](/v1/docs/language/groovy) +* [Language Haskell](/v1/docs/language/haskell) +* [Language Haxe](/v1/docs/language/haxe) +* [Language Java](/v1/docs/language/java) +* [Language Julia](/v1/docs/language/julia) +* [Language Nix](/v1/docs/language/nix) +* [Language Node Js](/v1/docs/language/node_js) +* [Language Objective-c](/v1/docs/language/objective-c) +* [Language Perl](/v1/docs/language/perl) +* [Language Perl6](/v1/docs/language/perl6) +* [Language Php](/v1/docs/language/php) +* [Language Python](/v1/docs/language/python) +* [Language R](/v1/docs/language/r) +* [Language Ruby](/v1/docs/language/ruby) +* [Language Rust](/v1/docs/language/rust) +* [Language Scala](/v1/docs/language/scala) +* [Language Shell](/v1/docs/language/shell) +* [Language Smalltalk](/v1/docs/language/smalltalk) +* [Notification Campfire](/v1/docs/notification/campfire) +* [Notification Email](/v1/docs/notification/email) +* [Notification Flowdock](/v1/docs/notification/flowdock) +* [Notification Frequency](/v1/docs/notification/frequency) +* [Notification Hipchat](/v1/docs/notification/hipchat) +* [IRC](/v1/docs/notification/irc) +* [Notification Pushover](/v1/docs/notification/pushover) +* [Notification Slack](/v1/docs/notification/slack) +* [Notification Template](/v1/docs/notification/template) +* [Notification Templates](/v1/docs/notification/templates) +* [Notification Webhooks](/v1/docs/notification/webhooks) \ No newline at end of file diff --git a/public/docs/language/android.md b/public/docs/language/android.md new file mode 100644 index 000000000..34f5283be --- /dev/null +++ b/public/docs/language/android.md @@ -0,0 +1,13 @@ +# Language Android + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/c.md b/public/docs/language/c.md new file mode 100644 index 000000000..330dfe70d --- /dev/null +++ b/public/docs/language/c.md @@ -0,0 +1,13 @@ +# Language C + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/clojure.md b/public/docs/language/clojure.md new file mode 100644 index 000000000..d1ab00d23 --- /dev/null +++ b/public/docs/language/clojure.md @@ -0,0 +1,13 @@ +# Language Clojure + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/cpp.md b/public/docs/language/cpp.md new file mode 100644 index 000000000..ffdc3d8ce --- /dev/null +++ b/public/docs/language/cpp.md @@ -0,0 +1,13 @@ +# Language Cpp + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/crystal.md b/public/docs/language/crystal.md new file mode 100644 index 000000000..ceaddac12 --- /dev/null +++ b/public/docs/language/crystal.md @@ -0,0 +1,13 @@ +# Language Crystal + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/csharp.md b/public/docs/language/csharp.md new file mode 100644 index 000000000..1d255412d --- /dev/null +++ b/public/docs/language/csharp.md @@ -0,0 +1,13 @@ +# Language Csharp + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/d.md b/public/docs/language/d.md new file mode 100644 index 000000000..d536301e9 --- /dev/null +++ b/public/docs/language/d.md @@ -0,0 +1,13 @@ +# Language D + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/dart.md b/public/docs/language/dart.md new file mode 100644 index 000000000..ef1f8993a --- /dev/null +++ b/public/docs/language/dart.md @@ -0,0 +1,13 @@ +# Language Dart + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/elixir.md b/public/docs/language/elixir.md new file mode 100644 index 000000000..9e494b5f6 --- /dev/null +++ b/public/docs/language/elixir.md @@ -0,0 +1,13 @@ +# Language Elixir + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/elm.md b/public/docs/language/elm.md new file mode 100644 index 000000000..6541facb6 --- /dev/null +++ b/public/docs/language/elm.md @@ -0,0 +1,13 @@ +# Language Elm + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/erlang.md b/public/docs/language/erlang.md new file mode 100644 index 000000000..49a7cbd2f --- /dev/null +++ b/public/docs/language/erlang.md @@ -0,0 +1,13 @@ +# Language Erlang + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/go.md b/public/docs/language/go.md new file mode 100644 index 000000000..5ff459372 --- /dev/null +++ b/public/docs/language/go.md @@ -0,0 +1,13 @@ +# Language Go + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/groovy.md b/public/docs/language/groovy.md new file mode 100644 index 000000000..24a2de5e1 --- /dev/null +++ b/public/docs/language/groovy.md @@ -0,0 +1,13 @@ +# Language Groovy + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/haskell.md b/public/docs/language/haskell.md new file mode 100644 index 000000000..d701174b6 --- /dev/null +++ b/public/docs/language/haskell.md @@ -0,0 +1,13 @@ +# Language Haskell + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/haxe.md b/public/docs/language/haxe.md new file mode 100644 index 000000000..1df02ba03 --- /dev/null +++ b/public/docs/language/haxe.md @@ -0,0 +1,13 @@ +# Language Haxe + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/java.md b/public/docs/language/java.md new file mode 100644 index 000000000..01f62cfb7 --- /dev/null +++ b/public/docs/language/java.md @@ -0,0 +1,13 @@ +# Language Java + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/julia.md b/public/docs/language/julia.md new file mode 100644 index 000000000..236275f1a --- /dev/null +++ b/public/docs/language/julia.md @@ -0,0 +1,13 @@ +# Language Julia + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/nix.md b/public/docs/language/nix.md new file mode 100644 index 000000000..c659b1b47 --- /dev/null +++ b/public/docs/language/nix.md @@ -0,0 +1,13 @@ +# Language Nix + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/node_js.md b/public/docs/language/node_js.md new file mode 100644 index 000000000..0915eb212 --- /dev/null +++ b/public/docs/language/node_js.md @@ -0,0 +1,13 @@ +# Language Node Js + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/objective-c.md b/public/docs/language/objective-c.md new file mode 100644 index 000000000..76a767a74 --- /dev/null +++ b/public/docs/language/objective-c.md @@ -0,0 +1,13 @@ +# Language Objective-c + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/perl.md b/public/docs/language/perl.md new file mode 100644 index 000000000..818c67819 --- /dev/null +++ b/public/docs/language/perl.md @@ -0,0 +1,13 @@ +# Language Perl + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/perl6.md b/public/docs/language/perl6.md new file mode 100644 index 000000000..7357fea6c --- /dev/null +++ b/public/docs/language/perl6.md @@ -0,0 +1,13 @@ +# Language Perl6 + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/php.md b/public/docs/language/php.md new file mode 100644 index 000000000..f2238cc4c --- /dev/null +++ b/public/docs/language/php.md @@ -0,0 +1,13 @@ +# Language Php + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/python.md b/public/docs/language/python.md new file mode 100644 index 000000000..0594f0c32 --- /dev/null +++ b/public/docs/language/python.md @@ -0,0 +1,13 @@ +# Language Python + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/r.md b/public/docs/language/r.md new file mode 100644 index 000000000..f51ceea0b --- /dev/null +++ b/public/docs/language/r.md @@ -0,0 +1,13 @@ +# Language R + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/ruby.md b/public/docs/language/ruby.md new file mode 100644 index 000000000..69dba3abb --- /dev/null +++ b/public/docs/language/ruby.md @@ -0,0 +1,13 @@ +# Language Ruby + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/rust.md b/public/docs/language/rust.md new file mode 100644 index 000000000..8393518bd --- /dev/null +++ b/public/docs/language/rust.md @@ -0,0 +1,13 @@ +# Language Rust + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/scala.md b/public/docs/language/scala.md new file mode 100644 index 000000000..079b4e164 --- /dev/null +++ b/public/docs/language/scala.md @@ -0,0 +1,13 @@ +# Language Scala + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/shell.md b/public/docs/language/shell.md new file mode 100644 index 000000000..de7004270 --- /dev/null +++ b/public/docs/language/shell.md @@ -0,0 +1,13 @@ +# Language Shell + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/language/smalltalk.md b/public/docs/language/smalltalk.md new file mode 100644 index 000000000..2d38a2836 --- /dev/null +++ b/public/docs/language/smalltalk.md @@ -0,0 +1,13 @@ +# Language Smalltalk + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/notification/campfire.md b/public/docs/notification/campfire.md new file mode 100644 index 000000000..1e820eaa9 --- /dev/null +++ b/public/docs/notification/campfire.md @@ -0,0 +1,37 @@ +# Notification Campfire + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +campfire: + rooms: "[ref:secures]" + template: string + enabled: true + on_success: always + on_failure: always +``` + +```yaml +campfire: "[ref:secures]" + +``` + +```yaml +campfire: true + +``` diff --git a/public/docs/notification/email.md b/public/docs/notification/email.md new file mode 100644 index 000000000..ff2b691e6 --- /dev/null +++ b/public/docs/notification/email.md @@ -0,0 +1,36 @@ +# Notification Email + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +email: + recipients: "[ref:secures]" + enabled: true + on_success: always + on_failure: always +``` + +```yaml +email: "[ref:secures]" + +``` + +```yaml +email: true + +``` diff --git a/public/docs/notification/flowdock.md b/public/docs/notification/flowdock.md new file mode 100644 index 000000000..1aac6883c --- /dev/null +++ b/public/docs/notification/flowdock.md @@ -0,0 +1,37 @@ +# Notification Flowdock + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +flowdock: + api_token: + template: string + enabled: true + on_success: always + on_failure: always +``` + +```yaml +flowdock: + +``` + +```yaml +flowdock: true + +``` diff --git a/public/docs/notification/frequency.md b/public/docs/notification/frequency.md new file mode 100644 index 000000000..dc0c5e22f --- /dev/null +++ b/public/docs/notification/frequency.md @@ -0,0 +1,13 @@ +# Notification Frequency + + + +## Type + +Enum (known String) + +## Flags + +None. + + diff --git a/public/docs/notification/hipchat.md b/public/docs/notification/hipchat.md new file mode 100644 index 000000000..f27016ffe --- /dev/null +++ b/public/docs/notification/hipchat.md @@ -0,0 +1,40 @@ +# Notification Hipchat + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +hipchat: + rooms: "[ref:secures]" + format: html + notify: true + on_pull_requests: true + template: string + enabled: true + on_success: always + on_failure: always +``` + +```yaml +hipchat: "[ref:secures]" + +``` + +```yaml +hipchat: true + +``` diff --git a/public/docs/notification/irc.md b/public/docs/notification/irc.md new file mode 100644 index 000000000..a864e46fa --- /dev/null +++ b/public/docs/notification/irc.md @@ -0,0 +1,43 @@ +# IRC + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +irc: + channels: "[ref:secures]" + channel_key: + password: + nickserv_password: + nick: + use_notice: true + skip_join: true + template: string + enabled: true + on_success: always + on_failure: always +``` + +```yaml +irc: "[ref:secures]" + +``` + +```yaml +irc: true + +``` diff --git a/public/docs/notification/pushover.md b/public/docs/notification/pushover.md new file mode 100644 index 000000000..4f1943de1 --- /dev/null +++ b/public/docs/notification/pushover.md @@ -0,0 +1,32 @@ +# Notification Pushover + + + +## Type + +Any of: + +* Map (Hash) +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +pushover: + enabled: true + api_key: + users: "[ref:secures]" + template: string + on_success: always + on_failure: always +``` + +```yaml +pushover: true + +``` diff --git a/public/docs/notification/slack.md b/public/docs/notification/slack.md new file mode 100644 index 000000000..da6217079 --- /dev/null +++ b/public/docs/notification/slack.md @@ -0,0 +1,38 @@ +# Notification Slack + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +slack: + rooms: "[ref:secures]" + template: string + enabled: true + on_success: always + on_failure: always + on_pull_requests: true +``` + +```yaml +slack: "[ref:secures]" + +``` + +```yaml +slack: true + +``` diff --git a/public/docs/notification/template.md b/public/docs/notification/template.md new file mode 100644 index 000000000..df04f4fae --- /dev/null +++ b/public/docs/notification/template.md @@ -0,0 +1,13 @@ +# Notification Template + + + +## Type + +String + +## Flags + +None. + + diff --git a/public/docs/notification/templates.md b/public/docs/notification/templates.md new file mode 100644 index 000000000..4345c19bb --- /dev/null +++ b/public/docs/notification/templates.md @@ -0,0 +1,28 @@ +# Notification Templates + + + +## Type + +Any of: + +* Sequence (Array) +* String + +## Flags + +None. + + +## Examples + +```yaml +template: +- string one +- string two +``` + +```yaml +template: string + +``` diff --git a/public/docs/notification/webhooks.md b/public/docs/notification/webhooks.md new file mode 100644 index 000000000..ebf09db1d --- /dev/null +++ b/public/docs/notification/webhooks.md @@ -0,0 +1,37 @@ +# Notification Webhooks + + + +## Type + +Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +webhooks: + urls: "[ref:secures]" + on_start: always + enabled: true + on_success: always + on_failure: always +``` + +```yaml +webhooks: "[ref:secures]" + +``` + +```yaml +webhooks: true + +``` diff --git a/public/docs/type/addons.md b/public/docs/type/addons.md new file mode 100644 index 000000000..cb167c06a --- /dev/null +++ b/public/docs/type/addons.md @@ -0,0 +1,13 @@ +# Addons + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/type/arch.md b/public/docs/type/arch.md new file mode 100644 index 000000000..8be2a8379 --- /dev/null +++ b/public/docs/type/arch.md @@ -0,0 +1,13 @@ +# Architecture + +The architecture that will be selected for the build environment. + +## Type + +Enum (known String) + +## Flags + +None. + + diff --git a/public/docs/type/archs.md b/public/docs/type/archs.md new file mode 100644 index 000000000..75a2b982b --- /dev/null +++ b/public/docs/type/archs.md @@ -0,0 +1,28 @@ +# Architectures + +The architectures that will be selected for the build environments. + +## Type + +Any of: + +* Sequence (Array) +* Enum (known String) + +## Flags + +* Expand: This is a [matrix expansion key](/matrix_expansion). + + +## Examples + +```yaml +arch: +- amd64 +- ppc64le +``` + +```yaml +arch: amd64 + +``` diff --git a/public/docs/type/branches.md b/public/docs/type/branches.md new file mode 100644 index 000000000..44e13e4d2 --- /dev/null +++ b/public/docs/type/branches.md @@ -0,0 +1,28 @@ +# Branches + +The branches your build will be run on. + +## Type + +Any of: + +* Map (Hash) +* + +## Flags + +None. + + +## Examples + +```yaml +branches: + only: "[ref:strs]" + except: "[ref:strs]" +``` + +```yaml +branches: "[ref:strs]" + +``` diff --git a/public/docs/type/cache.md b/public/docs/type/cache.md new file mode 100644 index 000000000..4b2b809b5 --- /dev/null +++ b/public/docs/type/cache.md @@ -0,0 +1,39 @@ +# Cache + + + +## Type + +Any of: + +* Map (Hash) +* + +## Flags + +None. + + +## Examples + +```yaml +cache: + apt: true + bundler: true + cargo: true + ccache: true + cocoapods: true + npm: true + packages: true + pip: true + yarn: true + edge: true + directories: "[ref:strs]" + timeout: 1 + branch: string +``` + +```yaml +cache: "[ref:strs]" + +``` diff --git a/public/docs/type/compilers.md b/public/docs/type/compilers.md new file mode 100644 index 000000000..0118fb30f --- /dev/null +++ b/public/docs/type/compilers.md @@ -0,0 +1,13 @@ +# Compilers + + + +## Type + + + +## Flags + +None. + + diff --git a/public/docs/type/conditions.md b/public/docs/type/conditions.md new file mode 100644 index 000000000..3644b1cc9 --- /dev/null +++ b/public/docs/type/conditions.md @@ -0,0 +1,13 @@ +# Conditions + + + +## Type + +Enum (known String) + +## Flags + +None. + + diff --git a/public/docs/type/deploys.md b/public/docs/type/deploys.md new file mode 100644 index 000000000..248af4fc8 --- /dev/null +++ b/public/docs/type/deploys.md @@ -0,0 +1,1888 @@ +# Deploys + + + +## Type + +Any of: + +* Sequence (Array) +* Any of: + +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) +* Any of: + +* Map (Hash) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +deploy: +- provider: anynines + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + space: string +``` + +```yaml +deploy: +- anynines +``` + +```yaml +deploy: +- provider: appfog + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + api_key: + address: "[ref:strs]" + metadata: string + after_deploy: "[ref:strs]" + app: string +``` + +```yaml +deploy: +- provider: appfog + email: + ".*": +``` + +```yaml +deploy: +- provider: appfog + email: +``` + +```yaml +deploy: +- provider: appfog + password: + ".*": +``` + +```yaml +deploy: +- provider: appfog + password: +``` + +```yaml +deploy: +- appfog +``` + +```yaml +deploy: +- provider: atlas + on: {} + allow_failure: true + skip_cleanup: true + edge: true + token: + app: string + exclude: "[ref:strs]" + include: "[ref:strs]" + address: string + vcs: true + metadata: "[ref:strs]" + debug: true + version: string +``` + +```yaml +deploy: +- atlas +``` + +```yaml +deploy: +- provider: azure_web_apps + on: {} + allow_failure: true + skip_cleanup: true + edge: true + site: string + slot: string + username: + password: + verbose: true +``` + +```yaml +deploy: +- azure_web_apps +``` + +```yaml +deploy: +- provider: bintray + on: {} + allow_failure: true + skip_cleanup: true + edge: true + file: string + user: + key: + passphrase: + dry_run: true +``` + +```yaml +deploy: +- bintray +``` + +```yaml +deploy: +- provider: bitballoon + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_token: + site_id: string + local_dir: string +``` + +```yaml +deploy: +- bitballoon +``` + +```yaml +deploy: +- provider: bluemixcf + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + api: string + space: string + region: string + manifest: string + skip_ssl_validation: true +``` + +```yaml +deploy: +- bluemixcf +``` + +```yaml +deploy: +- provider: boxfuse + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + secret: + configfile: string + payload: string + app: string + version: string + env: string + image: string + extra_args: string +``` + +```yaml +deploy: +- boxfuse +``` + +```yaml +deploy: +- provider: catalyze + on: {} + allow_failure: true + skip_cleanup: true + edge: true + target: string + path: string +``` + +```yaml +deploy: +- catalyze +``` + +```yaml +deploy: +- provider: chef_supermarket + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user_id: + client_key: + cookbook_category: string +``` + +```yaml +deploy: +- chef_supermarket +``` + +```yaml +deploy: +- provider: cloud66 + on: {} + allow_failure: true + skip_cleanup: true + edge: true + redeployment_hook: string +``` + +```yaml +deploy: +- cloud66 +``` + +```yaml +deploy: +- provider: cloudcontrol + on: {} + allow_failure: true + skip_cleanup: true + edge: true + email: + password: + deployment: string +``` + +```yaml +deploy: +- cloudcontrol +``` + +```yaml +deploy: +- provider: cloudfiles + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + api_key: + region: string + container: string + dot_match: true +``` + +```yaml +deploy: +- cloudfiles +``` + +```yaml +deploy: +- provider: cloudfoundry + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + api: string + space: string + key: string + manifest: string + skip_ssl_validation: true +``` + +```yaml +deploy: +- cloudfoundry +``` + +```yaml +deploy: +- provider: codedeploy + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + application: string + deployment_group: string + revision_type: s3 + commit_id: string + repository: string + region: string + wait_until_deployed: true + bucket: string + key: string +``` + +```yaml +deploy: +- codedeploy +``` + +```yaml +deploy: +- provider: deis + on: {} + allow_failure: true + skip_cleanup: true + edge: true + controller: string + username: + password: + app: string + cli_version: string +``` + +```yaml +deploy: +- deis +``` + +```yaml +deploy: +- provider: divshot + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + environment: string +``` + +```yaml +deploy: +- divshot +``` + +```yaml +deploy: +- provider: elasticbeanstalk + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + securet_access_key: + region: string + app: string + env: string + zip_file: string + bucket_name: string + bucket_path: string + only_create_app_version: true +``` + +```yaml +deploy: +- elasticbeanstalk +``` + +```yaml +deploy: +- provider: engineyard + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + api_key: + app: string + environment: string + migrate: string +``` + +```yaml +deploy: +- engineyard +``` + +```yaml +deploy: +- provider: firebase + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + token: + message: string +``` + +```yaml +deploy: +- firebase +``` + +```yaml +deploy: +- provider: gae + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + keyfile: string + config: string + version: string + no_promote: true + no_stop_previous_version: true + verbosity: string +``` + +```yaml +deploy: +- gae +``` + +```yaml +deploy: +- provider: gcs + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + bucket: string + upload_dir: string + local_dir: string + dot_match: true + acl: string + cache_control: string + detect_encoding: true +``` + +```yaml +deploy: +- gcs +``` + +```yaml +deploy: +- provider: hackage + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: +``` + +```yaml +deploy: +- hackage +``` + +```yaml +deploy: +- provider: heroku + on: {} + allow_failure: true + skip_cleanup: true + edge: true + strategy: api + buildpack: string + app: string + api_key: + run: "[ref:strs]" +``` + +```yaml +deploy: +- heroku +``` + +```yaml +deploy: +- provider: lambda + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + region: string + function_name: string + role: string + handler_name: string + module_name: string + zip: string + description: string + timeout: string + memory_size: string + runtime: string + environment_variables: + security_group_ids: "[ref:strs]" + subnet_ids: "[ref:strs]" + dead_letter_config: string + kms_key_arn: string + tracing_mode: Active + publish: true + function_tags: +``` + +```yaml +deploy: +- lambda +``` + +```yaml +deploy: +- provider: launchpad + slug: string + oauth_token: + oauth_token_secret: + on: {} + allow_failure: true + skip_cleanup: true + edge: true +``` + +```yaml +deploy: +- launchpad +``` + +```yaml +deploy: +- provider: modulus + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + project_name: string +``` + +```yaml +deploy: +- modulus +``` + +```yaml +deploy: +- provider: npm + on: {} + allow_failure: true + skip_cleanup: true + edge: true + email: + api_key: +``` + +```yaml +deploy: +- npm +``` + +```yaml +deploy: +- provider: openshift + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + domain: string + app: string + deployment_branch: string +``` + +```yaml +deploy: +- openshift +``` + +```yaml +deploy: +- provider: opsworks + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + app_id: string + instance_ids: string + layer_ids: string + migrate: true + wait_until_deployed: string + custom_json: string +``` + +```yaml +deploy: +- opsworks +``` + +```yaml +deploy: +- provider: packagecloud + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + token: + repository: string + local_dir: string + dist: string + package_glob: string + force: true +``` + +```yaml +deploy: +- packagecloud +``` + +```yaml +deploy: +- provider: pages + on: {} + allow_failure: true + skip_cleanup: true + edge: true + github_token: + repo: string + target_branch: string + local_dir: string + fqdn: string + project_name: string + email: string + name: string + github_url: string + keep_history: true + verbose: true + allow_empty_commit: true + committer_from_gh: true + deployment_file: true +``` + +```yaml +deploy: +- pages +``` + +```yaml +deploy: +- provider: puppetforge + user: + password: + on: {} + allow_failure: true + skip_cleanup: true + edge: true + url: string +``` + +```yaml +deploy: +- puppetforge +``` + +```yaml +deploy: +- provider: pypi + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + api_key: + server: string + distributions: string + docs_dir: string +``` + +```yaml +deploy: +- pypi +``` + +```yaml +deploy: +- provider: releases + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + api_key: + repo: string + file: "[ref:strs]" + file_glob: string + overwrite: string + release_number: string + prerelease: true +``` + +```yaml +deploy: +- releases +``` + +```yaml +deploy: +- provider: rubygems + on: {} + allow_failure: true + skip_cleanup: true + edge: true + gem: string + file: string + gemspec: string + api_key: +``` + +```yaml +deploy: +- rubygems +``` + +```yaml +deploy: +- provider: s3 + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + bucket: string + region: string + upload_dir: string + storage_class: string + local_dir: string + detect_encoding: true + cache_control: string + expires: string + acl: string + dot_match: true + index_document_suffix: string + default_text_charset: string + server_side_encryption: true +``` + +```yaml +deploy: +- s3 +``` + +```yaml +deploy: +- provider: scalingo + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + api_key: + remote: string + branch: string + app: string +``` + +```yaml +deploy: +- scalingo +``` + +```yaml +deploy: +- provider: script + on: {} + allow_failure: true + skip_cleanup: true + edge: true + script: string +``` + +```yaml +deploy: +- script +``` + +```yaml +deploy: +- provider: surge + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + domain: string +``` + +```yaml +deploy: +- surge +``` + +```yaml +deploy: +- provider: testfairy + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + app_file: string + symbols_file: string + testers_groups: string + notify: true + auto_update: true + video_quality: string + screenshot_quality: string + screenshot_interval: string + max_duration: string + advanced_options: string + data_only_wifi: true + record_on_backgroup: true + video: true + icon_watermark: true + metrics: string +``` + +```yaml +deploy: +- testfairy +``` + +```yaml +deploy: + provider: anynines + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + space: string +``` + +```yaml +deploy: anynines + +``` + +```yaml +deploy: + provider: appfog + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + api_key: + address: "[ref:strs]" + metadata: string + after_deploy: "[ref:strs]" + app: string +``` + +```yaml +deploy: + provider: appfog + email: + ".*": +``` + +```yaml +deploy: + provider: appfog + email: +``` + +```yaml +deploy: + provider: appfog + password: + ".*": +``` + +```yaml +deploy: + provider: appfog + password: +``` + +```yaml +deploy: appfog + +``` + +```yaml +deploy: + provider: atlas + on: {} + allow_failure: true + skip_cleanup: true + edge: true + token: + app: string + exclude: "[ref:strs]" + include: "[ref:strs]" + address: string + vcs: true + metadata: "[ref:strs]" + debug: true + version: string +``` + +```yaml +deploy: atlas + +``` + +```yaml +deploy: + provider: azure_web_apps + on: {} + allow_failure: true + skip_cleanup: true + edge: true + site: string + slot: string + username: + password: + verbose: true +``` + +```yaml +deploy: azure_web_apps + +``` + +```yaml +deploy: + provider: bintray + on: {} + allow_failure: true + skip_cleanup: true + edge: true + file: string + user: + key: + passphrase: + dry_run: true +``` + +```yaml +deploy: bintray + +``` + +```yaml +deploy: + provider: bitballoon + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_token: + site_id: string + local_dir: string +``` + +```yaml +deploy: bitballoon + +``` + +```yaml +deploy: + provider: bluemixcf + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + api: string + space: string + region: string + manifest: string + skip_ssl_validation: true +``` + +```yaml +deploy: bluemixcf + +``` + +```yaml +deploy: + provider: boxfuse + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + secret: + configfile: string + payload: string + app: string + version: string + env: string + image: string + extra_args: string +``` + +```yaml +deploy: boxfuse + +``` + +```yaml +deploy: + provider: catalyze + on: {} + allow_failure: true + skip_cleanup: true + edge: true + target: string + path: string +``` + +```yaml +deploy: catalyze + +``` + +```yaml +deploy: + provider: chef_supermarket + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user_id: + client_key: + cookbook_category: string +``` + +```yaml +deploy: chef_supermarket + +``` + +```yaml +deploy: + provider: cloud66 + on: {} + allow_failure: true + skip_cleanup: true + edge: true + redeployment_hook: string +``` + +```yaml +deploy: cloud66 + +``` + +```yaml +deploy: + provider: cloudcontrol + on: {} + allow_failure: true + skip_cleanup: true + edge: true + email: + password: + deployment: string +``` + +```yaml +deploy: cloudcontrol + +``` + +```yaml +deploy: + provider: cloudfiles + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + api_key: + region: string + container: string + dot_match: true +``` + +```yaml +deploy: cloudfiles + +``` + +```yaml +deploy: + provider: cloudfoundry + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + organization: string + api: string + space: string + key: string + manifest: string + skip_ssl_validation: true +``` + +```yaml +deploy: cloudfoundry + +``` + +```yaml +deploy: + provider: codedeploy + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + application: string + deployment_group: string + revision_type: s3 + commit_id: string + repository: string + region: string + wait_until_deployed: true + bucket: string + key: string +``` + +```yaml +deploy: codedeploy + +``` + +```yaml +deploy: + provider: deis + on: {} + allow_failure: true + skip_cleanup: true + edge: true + controller: string + username: + password: + app: string + cli_version: string +``` + +```yaml +deploy: deis + +``` + +```yaml +deploy: + provider: divshot + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + environment: string +``` + +```yaml +deploy: divshot + +``` + +```yaml +deploy: + provider: elasticbeanstalk + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + securet_access_key: + region: string + app: string + env: string + zip_file: string + bucket_name: string + bucket_path: string + only_create_app_version: true +``` + +```yaml +deploy: elasticbeanstalk + +``` + +```yaml +deploy: + provider: engineyard + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + api_key: + app: string + environment: string + migrate: string +``` + +```yaml +deploy: engineyard + +``` + +```yaml +deploy: + provider: firebase + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + token: + message: string +``` + +```yaml +deploy: firebase + +``` + +```yaml +deploy: + provider: gae + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + keyfile: string + config: string + version: string + no_promote: true + no_stop_previous_version: true + verbosity: string +``` + +```yaml +deploy: gae + +``` + +```yaml +deploy: + provider: gcs + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + bucket: string + upload_dir: string + local_dir: string + dot_match: true + acl: string + cache_control: string + detect_encoding: true +``` + +```yaml +deploy: gcs + +``` + +```yaml +deploy: + provider: hackage + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: +``` + +```yaml +deploy: hackage + +``` + +```yaml +deploy: + provider: heroku + on: {} + allow_failure: true + skip_cleanup: true + edge: true + strategy: api + buildpack: string + app: string + api_key: + run: "[ref:strs]" +``` + +```yaml +deploy: heroku + +``` + +```yaml +deploy: + provider: lambda + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + region: string + function_name: string + role: string + handler_name: string + module_name: string + zip: string + description: string + timeout: string + memory_size: string + runtime: string + environment_variables: + security_group_ids: "[ref:strs]" + subnet_ids: "[ref:strs]" + dead_letter_config: string + kms_key_arn: string + tracing_mode: Active + publish: true + function_tags: +``` + +```yaml +deploy: lambda + +``` + +```yaml +deploy: + provider: launchpad + slug: string + oauth_token: + oauth_token_secret: + on: {} + allow_failure: true + skip_cleanup: true + edge: true +``` + +```yaml +deploy: launchpad + +``` + +```yaml +deploy: + provider: modulus + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + project_name: string +``` + +```yaml +deploy: modulus + +``` + +```yaml +deploy: + provider: npm + on: {} + allow_failure: true + skip_cleanup: true + edge: true + email: + api_key: +``` + +```yaml +deploy: npm + +``` + +```yaml +deploy: + provider: openshift + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + domain: string + app: string + deployment_branch: string +``` + +```yaml +deploy: openshift + +``` + +```yaml +deploy: + provider: opsworks + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + app_id: string + instance_ids: string + layer_ids: string + migrate: true + wait_until_deployed: string + custom_json: string +``` + +```yaml +deploy: opsworks + +``` + +```yaml +deploy: + provider: packagecloud + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + token: + repository: string + local_dir: string + dist: string + package_glob: string + force: true +``` + +```yaml +deploy: packagecloud + +``` + +```yaml +deploy: + provider: pages + on: {} + allow_failure: true + skip_cleanup: true + edge: true + github_token: + repo: string + target_branch: string + local_dir: string + fqdn: string + project_name: string + email: string + name: string + github_url: string + keep_history: true + verbose: true + allow_empty_commit: true + committer_from_gh: true + deployment_file: true +``` + +```yaml +deploy: pages + +``` + +```yaml +deploy: + provider: puppetforge + user: + password: + on: {} + allow_failure: true + skip_cleanup: true + edge: true + url: string +``` + +```yaml +deploy: puppetforge + +``` + +```yaml +deploy: + provider: pypi + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + api_key: + server: string + distributions: string + docs_dir: string +``` + +```yaml +deploy: pypi + +``` + +```yaml +deploy: + provider: releases + on: {} + allow_failure: true + skip_cleanup: true + edge: true + user: + password: + api_key: + repo: string + file: "[ref:strs]" + file_glob: string + overwrite: string + release_number: string + prerelease: true +``` + +```yaml +deploy: releases + +``` + +```yaml +deploy: + provider: rubygems + on: {} + allow_failure: true + skip_cleanup: true + edge: true + gem: string + file: string + gemspec: string + api_key: +``` + +```yaml +deploy: rubygems + +``` + +```yaml +deploy: + provider: s3 + on: {} + allow_failure: true + skip_cleanup: true + edge: true + access_key_id: + secret_access_key: + bucket: string + region: string + upload_dir: string + storage_class: string + local_dir: string + detect_encoding: true + cache_control: string + expires: string + acl: string + dot_match: true + index_document_suffix: string + default_text_charset: string + server_side_encryption: true +``` + +```yaml +deploy: s3 + +``` + +```yaml +deploy: + provider: scalingo + on: {} + allow_failure: true + skip_cleanup: true + edge: true + username: + password: + api_key: + remote: string + branch: string + app: string +``` + +```yaml +deploy: scalingo + +``` + +```yaml +deploy: + provider: script + on: {} + allow_failure: true + skip_cleanup: true + edge: true + script: string +``` + +```yaml +deploy: script + +``` + +```yaml +deploy: + provider: surge + on: {} + allow_failure: true + skip_cleanup: true + edge: true + project: string + domain: string +``` + +```yaml +deploy: surge + +``` + +```yaml +deploy: + provider: testfairy + on: {} + allow_failure: true + skip_cleanup: true + edge: true + api_key: + app_file: string + symbols_file: string + testers_groups: string + notify: true + auto_update: true + video_quality: string + screenshot_quality: string + screenshot_interval: string + max_duration: string + advanced_options: string + data_only_wifi: true + record_on_backgroup: true + video: true + icon_watermark: true + metrics: string +``` + +```yaml +deploy: testfairy + +``` diff --git a/public/docs/type/dist.md b/public/docs/type/dist.md new file mode 100644 index 000000000..c244b10d0 --- /dev/null +++ b/public/docs/type/dist.md @@ -0,0 +1,13 @@ +# Dist + + + +## Type + +Enum (known String) + +## Flags + +None. + + diff --git a/public/docs/type/env.md b/public/docs/type/env.md new file mode 100644 index 000000000..2582af1e3 --- /dev/null +++ b/public/docs/type/env.md @@ -0,0 +1,61 @@ +# Env + + + +## Type + +Any of: + +* Map (Hash) +* Any of: + +* Sequence (Array) +* Any of: + +* Map (Hash) +* Map (Hash) +* String + +## Flags + +* Expand: This is a [matrix expansion key](/matrix_expansion). + + +## Examples + +```yaml +env: + global: string + matrix: string +``` + +```yaml +env: +- secure: string +``` + +```yaml +env: +- "^(?!global|matrix)": string +``` + +```yaml +env: +- string one +- string two +``` + +```yaml +env: + secure: string +``` + +```yaml +env: + "^(?!global|matrix)": string +``` + +```yaml +env: string + +``` diff --git a/public/docs/type/env_var.md b/public/docs/type/env_var.md new file mode 100644 index 000000000..952a45dbe --- /dev/null +++ b/public/docs/type/env_var.md @@ -0,0 +1,33 @@ +# Env Var + + + +## Type + +Any of: + +* Map (Hash) +* Map (Hash) +* String + +## Flags + +None. + + +## Examples + +```yaml +type: + secure: string +``` + +```yaml +type: + "^(?!global|matrix)": string +``` + +```yaml +type: string + +``` diff --git a/public/docs/type/env_vars.md b/public/docs/type/env_vars.md new file mode 100644 index 000000000..dcb35ac9a --- /dev/null +++ b/public/docs/type/env_vars.md @@ -0,0 +1,52 @@ +# Env Vars + + + +## Type + +Any of: + +* Sequence (Array) +* Any of: + +* Map (Hash) +* Map (Hash) +* String + +## Flags + +None. + + +## Examples + +```yaml +env: +- secure: string +``` + +```yaml +env: +- "^(?!global|matrix)": string +``` + +```yaml +env: +- string one +- string two +``` + +```yaml +env: + secure: string +``` + +```yaml +env: + "^(?!global|matrix)": string +``` + +```yaml +env: string + +``` diff --git a/public/docs/type/git.md b/public/docs/type/git.md new file mode 100644 index 000000000..8a8ddfb4e --- /dev/null +++ b/public/docs/type/git.md @@ -0,0 +1,13 @@ +# Git + + + +## Type + +Map (Hash) + +## Flags + +None. + + diff --git a/public/docs/type/group.md b/public/docs/type/group.md new file mode 100644 index 000000000..8a84cbcb3 --- /dev/null +++ b/public/docs/type/group.md @@ -0,0 +1,13 @@ +# Group + + + +## Type + +String + +## Flags + +None. + + diff --git a/public/docs/type/import.md b/public/docs/type/import.md new file mode 100644 index 000000000..6063518e0 --- /dev/null +++ b/public/docs/type/import.md @@ -0,0 +1,28 @@ +# Import + + + +## Type + +Any of: + +* Map (Hash) +* String + +## Flags + +None. + + +## Examples + +```yaml +type: + source: string + mode: merge +``` + +```yaml +type: string + +``` diff --git a/public/docs/type/imports.md b/public/docs/type/imports.md new file mode 100644 index 000000000..65b83cfb1 --- /dev/null +++ b/public/docs/type/imports.md @@ -0,0 +1,43 @@ +# Imports + + + +## Type + +Any of: + +* Sequence (Array) +* Any of: + +* Map (Hash) +* String + +## Flags + +None. + + +## Examples + +```yaml +import: +- source: string + mode: merge +``` + +```yaml +import: +- string one +- string two +``` + +```yaml +import: + source: string + mode: merge +``` + +```yaml +import: string + +``` diff --git a/public/docs/type/job.md b/public/docs/type/job.md new file mode 100644 index 000000000..e562f01d1 --- /dev/null +++ b/public/docs/type/job.md @@ -0,0 +1,13 @@ +# Job + + + +## Type + + + +## Flags + +None. + + diff --git a/public/docs/type/languages.md b/public/docs/type/languages.md new file mode 100644 index 000000000..ce51c2f90 --- /dev/null +++ b/public/docs/type/languages.md @@ -0,0 +1,300 @@ +# Languages + + + +## Type + +Any of: + +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) +* Map (Hash) + +## Flags + +None. + + +## Examples + +```yaml +type: + jdk: "[ref:strs]" + android: + components: "[ref:strs]" + licenses: "[ref:strs]" +``` + +```yaml +type: {} + +``` + +```yaml +type: + jdk: "[ref:strs]" + lein: string +``` + +```yaml +type: {} + +``` + +```yaml +type: + crystal: "[ref:strs]" +``` + +```yaml +type: + dotnet: "[ref:strs]" + mono: "[ref:strs]" + solution: "[ref:strs]" +``` + +```yaml +type: + d: "[ref:strs]" +``` + +```yaml +type: + dart: "[ref:strs]" + with_content_shell: true +``` + +```yaml +type: + elixir: "[ref:strs]" + otp_release: "[ref:strs]" +``` + +```yaml +type: + elm: "[ref:strs]" + elm_format: string + elm_test: string +``` + +```yaml +type: + otp_release: "[ref:strs]" +``` + +```yaml +type: + go: "[ref:strs]" + gobuild_args: string + go_import_path: string + gimme_config: + url: string + force_reinstall: true +``` + +```yaml +type: + jdk: "[ref:strs]" +``` + +```yaml +type: + ghc: "[ref:strs]" +``` + +```yaml +type: + haxe: "[ref:strs]" + hxml: "[ref:strs]" + neko: string +``` + +```yaml +type: + jdk: "[ref:strs]" +``` + +```yaml +type: + julia: "[ref:strs]" +``` + +```yaml +type: {} + +``` + +```yaml +type: + node_js: "[ref:strs]" + npm_args: string +``` + +```yaml +type: + rvm: "[ref:strs]" + gemfile: "[ref:strs]" + xcode_scheme: "[ref:strs]" + xcode_sdk: "[ref:strs]" + podfile: string + bundler_args: string + xcode_project: string + xcode_workspace: string + xctool_args: string +``` + +```yaml +type: + perl: "[ref:strs]" +``` + +```yaml +type: + perl6: "[ref:strs]" +``` + +```yaml +type: + php: "[ref:strs]" + composer_args: string +``` + +```yaml +type: + python: "[ref:strs]" + virtualenv: + system_site_packages: true +``` + +```yaml +type: + r: "[ref:strs]" + r_packages: "[ref:strs]" + r_binary_packages: "[ref:strs]" + r_github_packages: "[ref:strs]" + apt_packages: "[ref:strs]" + bioc_packages: "[ref:strs]" + brew_packages: "[ref:strs]" + bioc: string + bioc_check: true + bioc_required: true + bioc_use_devel: true + cran: string + disable_homebrew: true + latex: true + pandoc: true + pandoc_version: string + r_build_args: string + r_check_args: string + r_check_revdep: true + warnings_are_errors: true + remotes: string + repos: {} +``` + +```yaml +type: + rvm: "[ref:strs]" + gemfile: "[ref:strs]" + jdk: "[ref:strs]" + bundler_args: string +``` + +```yaml +type: + rust: "[ref:strs]" +``` + +```yaml +type: + scala: "[ref:strs]" + jdk: "[ref:strs]" + sbt_args: string +``` + +```yaml +type: {} + +``` + +```yaml +type: + smalltalk: "[ref:strs]" + smalltalk_config: "[ref:strs]" + smalltalk_edge: true +``` + +```yaml +type: {} + +``` + +```yaml +type: {} + +``` + +```yaml +type: {} + +``` + +```yaml +type: {} + +``` + +```yaml +type: {} + +``` + +```yaml +type: {} + +``` + +```yaml +type: {} + +``` + +```yaml +type: {} + +``` diff --git a/public/docs/type/matrix.md b/public/docs/type/matrix.md new file mode 100644 index 000000000..269300379 --- /dev/null +++ b/public/docs/type/matrix.md @@ -0,0 +1,38 @@ +# Matrix + + + +## Type + +Any of: + +* Map (Hash) +* Any of: + +* Sequence (Array) +* + +## Flags + +None. + + +## Examples + +```yaml +matrix: + include: + exclude: + allow_failures: + fast_finish: true +``` + +```yaml +matrix: +- +``` + +```yaml +matrix: + +``` diff --git a/public/docs/type/matrix_entries.md b/public/docs/type/matrix_entries.md new file mode 100644 index 000000000..7ec365cd4 --- /dev/null +++ b/public/docs/type/matrix_entries.md @@ -0,0 +1,27 @@ +# Matrix Entries + + + +## Type + +Any of: + +* Sequence (Array) +* + +## Flags + +None. + + +## Examples + +```yaml +allow_failures: +- +``` + +```yaml +allow_failures: + +``` diff --git a/public/docs/type/matrix_entry.md b/public/docs/type/matrix_entry.md new file mode 100644 index 000000000..3802133d4 --- /dev/null +++ b/public/docs/type/matrix_entry.md @@ -0,0 +1,13 @@ +# Matrix Entry + + + +## Type + + + +## Flags + +None. + + diff --git a/public/docs/type/notifications.md b/public/docs/type/notifications.md new file mode 100644 index 000000000..98cb12942 --- /dev/null +++ b/public/docs/type/notifications.md @@ -0,0 +1,53 @@ +# Notifications + + + +## Type + +Any of: + +* Map (Hash) +* Any of: + +* Map (Hash) +* +* Boolean + +## Flags + +None. + + +## Examples + +```yaml +notifications: + campfire: true + email: true + flowdock: true + hipchat: true + irc: true + pushover: true + slack: true + webhooks: true + on_success: always + on_failure: always +``` + +```yaml +notifications: + recipients: "[ref:secures]" + enabled: true + on_success: always + on_failure: always +``` + +```yaml +notifications: "[ref:secures]" + +``` + +```yaml +notifications: true + +``` diff --git a/public/docs/type/os.md b/public/docs/type/os.md new file mode 100644 index 000000000..88326f38b --- /dev/null +++ b/public/docs/type/os.md @@ -0,0 +1,13 @@ +# Os + + + +## Type + +Enum (known String) + +## Flags + +None. + + diff --git a/public/docs/type/oss.md b/public/docs/type/oss.md new file mode 100644 index 000000000..13ea190cf --- /dev/null +++ b/public/docs/type/oss.md @@ -0,0 +1,28 @@ +# Oss + + + +## Type + +Any of: + +* Sequence (Array) +* Enum (known String) + +## Flags + +* Expand: This is a [matrix expansion key](/matrix_expansion). + + +## Examples + +```yaml +os: +- linux +- osx +``` + +```yaml +os: linux + +``` diff --git a/public/docs/type/service.md b/public/docs/type/service.md new file mode 100644 index 000000000..dad1aae2a --- /dev/null +++ b/public/docs/type/service.md @@ -0,0 +1,13 @@ +# Service + + + +## Type + +Enum (known String) + +## Flags + +None. + + diff --git a/public/docs/type/services.md b/public/docs/type/services.md new file mode 100644 index 000000000..54c2ceb24 --- /dev/null +++ b/public/docs/type/services.md @@ -0,0 +1,28 @@ +# Services + + + +## Type + +Any of: + +* Sequence (Array) +* Enum (known String) + +## Flags + +None. + + +## Examples + +```yaml +services: +- cassandra +- couchdb +``` + +```yaml +services: cassandra + +``` diff --git a/public/docs/type/stack.md b/public/docs/type/stack.md new file mode 100644 index 000000000..00a393871 --- /dev/null +++ b/public/docs/type/stack.md @@ -0,0 +1,13 @@ +# Stack + + + +## Type + +Enum (known String) + +## Flags + +* Edge: + + diff --git a/public/docs/type/stage.md b/public/docs/type/stage.md new file mode 100644 index 000000000..3d1f75ea7 --- /dev/null +++ b/public/docs/type/stage.md @@ -0,0 +1,28 @@ +# Stage + + + +## Type + +Any of: + +* Map (Hash) +* String + +## Flags + +None. + + +## Examples + +```yaml +stage: + name: job name + if: string +``` + +```yaml +stage: job name + +``` diff --git a/public/docs/type/stages.md b/public/docs/type/stages.md new file mode 100644 index 000000000..793df9fa8 --- /dev/null +++ b/public/docs/type/stages.md @@ -0,0 +1,43 @@ +# Stages + + + +## Type + +Any of: + +* Sequence (Array) +* Any of: + +* Map (Hash) +* String + +## Flags + +None. + + +## Examples + +```yaml +stages: +- name: job name + if: string +``` + +```yaml +stages: +- job name one +- job name two +``` + +```yaml +stages: + name: job name + if: string +``` + +```yaml +stages: job name + +``` diff --git a/public/docs/type/sudo.md b/public/docs/type/sudo.md new file mode 100644 index 000000000..d991f7067 --- /dev/null +++ b/public/docs/type/sudo.md @@ -0,0 +1,27 @@ +# Sudo + + + +## Type + +Any of: + +* Boolean +* String + +## Flags + +None. + + +## Examples + +```yaml +sudo: true + +``` + +```yaml +sudo: string + +``` diff --git a/public/docs/type/version.md b/public/docs/type/version.md new file mode 100644 index 000000000..6851e640c --- /dev/null +++ b/public/docs/type/version.md @@ -0,0 +1,13 @@ +# Version + + + +## Type + +String + +## Flags + +None. + +