DPL v2 update (travis-ci#3415)

* Rewrite deployment opt in section * feat: set dpl v2 as a default version * fix: correct formatting * style: improve code layout
Rachelmorrell · Oct 16, 2024 · d703858 · d703858
1 parent a3e3a6f
commit d703858
Show file tree

Hide file tree

Showing 31 changed files with 131 additions and 105 deletions.
diff --git a/_includes/deploy/opt_in.md b/_includes/deploy/opt_in.md
@@ -1,12 +1,30 @@
-## How to opt in to v2
+## How to opt in to different deployment tooling versions
 
-In order to use version `v2` of our deployment tooling, please add the
+In order to use different version of our deployment tooling, please add the
 following to your `.travis.yml`:
 
 ```yaml
 deploy:
   provider: <provider>
   # ⋮
+  dpl_version: <version> # Optional, defaults to the latest stable version
+```
+if you want to use the latest edge version of the deployment tooling:
+
+```yaml
+deploy:
+  provider: <provider>
+  # ⋮
+  edge: true
+```
+if you want to use other edge version of the deployment tooling:
+
+```yaml
+deploy:
+  provider: <provider>
+  # ⋮
+  dpl_version: <version.beta>
   edge: true
 ```
+
 {: data-file=".travis.yml"}
diff --git a/_includes/deploy/providers/anynines.md b/_includes/deploy/providers/anynines.md
@@ -43,4 +43,4 @@ All options can be given as environment variables if prefixed with `ANYNINES_`.
 
 For example, `password` can be given as `ANYNINES_PASSWORD=<password>`.
 
-{% include deploy/secrets.md name="password" env_name="ANYNINES_PASSWORD" %}
+{% include deploy/secrets.md name="password" env_name="ANYNINES_PASSWORD" %}
diff --git a/_includes/deploy/providers/bintray.md b/_includes/deploy/providers/bintray.md
@@ -18,7 +18,7 @@ deploy:
 
 ## Status
 
-Support for deployments to Bintray is *stable**.
+Support for deployments to Bintray is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -39,4 +39,4 @@ All options can be given as environment variables if prefixed with `BINTRAY_`.
 
 For example, `key` can be given as `BINTRAY_KEY=<key>`.
 
-{% include deploy/secrets.md name="key" env_name="BINTRAY_KEY" %}
+{% include deploy/secrets.md name="key" env_name="BINTRAY_KEY" %}
diff --git a/_includes/deploy/providers/bluemixcloudfoundry.md b/_includes/deploy/providers/bluemixcloudfoundry.md
@@ -19,7 +19,7 @@ deploy:
 
 ## Status
 
-Support for deployments to Bluemix Cloud Foundry is *stable**.
+Support for deployments to Bluemix Cloud Foundry is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -46,4 +46,4 @@ All options can be given as environment variables if prefixed with `CLOUDFOUNDRY
 
 For example, `password` can be given as `CLOUDFOUNDRY_PASSWORD=<password>`.
 
-{% include deploy/secrets.md name="password" env_name="CLOUDFOUNDRY_PASSWORD" %}
+{% include deploy/secrets.md name="password" env_name="CLOUDFOUNDRY_PASSWORD" %}
diff --git a/_includes/deploy/providers/cargo.md b/_includes/deploy/providers/cargo.md
@@ -16,7 +16,7 @@ deploy:
 
 ## Status
 
-Support for deployments to Cargo is *stable**.
+Support for deployments to Cargo is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -35,4 +35,4 @@ All options can be given as environment variables if prefixed with `CARGO_`.
 
 For example, `token` can be given as `CARGO_TOKEN=<token>`.
 
-{% include deploy/secrets.md name="token" env_name="CARGO_TOKEN" %}
+{% include deploy/secrets.md name="token" env_name="CARGO_TOKEN" %}
diff --git a/_includes/deploy/providers/cloudformation.md b/_includes/deploy/providers/cloudformation.md
@@ -19,7 +19,7 @@ deploy:
 
 ## Status
 
-Support for deployments to AWS CloudFormation is *stable**.
+Support for deployments to AWS CloudFormation is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -49,9 +49,9 @@ Use the following options to further configure the deployment.
 
 All options can be given as environment variables if prefixed with `AWS_` or `CLOUDFORMATION_`.
 
-For example, `access_key_id` can be given as 
+For example, `access_key_id` can be given as
 
-* `AWS_ACCESS_KEY_ID=<access_key_id>` or 
+* `AWS_ACCESS_KEY_ID=<access_key_id>` or
 * `CLOUDFORMATION_ACCESS_KEY_ID=<access_key_id>`
 
-{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
+{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
diff --git a/_includes/deploy/providers/cloudfoundry.md b/_includes/deploy/providers/cloudfoundry.md
@@ -19,7 +19,7 @@ deploy:
 
 ## Status
 
-Support for deployments to Cloud Foundry is *stable**.
+Support for deployments to Cloud Foundry is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -47,4 +47,4 @@ All options can be given as environment variables if prefixed with `CLOUDFOUNDRY
 
 For example, `password` can be given as `CLOUDFOUNDRY_PASSWORD=<password>`.
 
-{% include deploy/secrets.md name="password" env_name="CLOUDFOUNDRY_PASSWORD" %}
+{% include deploy/secrets.md name="password" env_name="CLOUDFOUNDRY_PASSWORD" %}
diff --git a/_includes/deploy/providers/codedeploy.md b/_includes/deploy/providers/codedeploy.md
@@ -18,7 +18,7 @@ deploy:
 
 ## Status
 
-Support for deployments to AWS Code Deploy is *stable**.
+Support for deployments to AWS Code Deploy is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -48,9 +48,9 @@ Use the following options to further configure the deployment.
 
 All options can be given as environment variables if prefixed with `AWS_` or `CODEDEPLOY_`.
 
-For example, `access_key_id` can be given as 
+For example, `access_key_id` can be given as
 
-* `AWS_ACCESS_KEY_ID=<access_key_id>` or 
+* `AWS_ACCESS_KEY_ID=<access_key_id>` or
 * `CODEDEPLOY_ACCESS_KEY_ID=<access_key_id>`
 ## Interpolation variables
 
@@ -86,4 +86,4 @@ For example: "Current build number: ${TRAVIS_BUILD_NUMBER}".
 See [here](/user/environment-variables/#default-environment-variables)
 for a list of default environment variables set.
 
-{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
+{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
diff --git a/_includes/deploy/providers/elasticbeanstalk.md b/_includes/deploy/providers/elasticbeanstalk.md
@@ -18,7 +18,7 @@ deploy:
 
 ## Status
 
-Support for deployments to AWS Elastic Beanstalk is *stable**.
+Support for deployments to AWS Elastic Beanstalk is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -45,9 +45,9 @@ Use the following options to further configure the deployment.
 
 All options can be given as environment variables if prefixed with `AWS_` or `ELASTIC_BEANSTALK_`.
 
-For example, `access_key_id` can be given as 
+For example, `access_key_id` can be given as
 
-* `AWS_ACCESS_KEY_ID=<access_key_id>` or 
+* `AWS_ACCESS_KEY_ID=<access_key_id>` or
 * `ELASTIC_BEANSTALK_ACCESS_KEY_ID=<access_key_id>`
 
-{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
+{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
diff --git a/_includes/deploy/providers/firebase.md b/_includes/deploy/providers/firebase.md
@@ -16,7 +16,7 @@ deploy:
 
 ## Status
 
-Support for deployments to Firebase is *stable**.
+Support for deployments to Firebase is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -38,4 +38,4 @@ All options can be given as environment variables if prefixed with `FIREBASE_`.
 
 For example, `token` can be given as `FIREBASE_TOKEN=<token>`.
 
-{% include deploy/secrets.md name="token" env_name="FIREBASE_TOKEN" %}
+{% include deploy/secrets.md name="token" env_name="FIREBASE_TOKEN" %}
diff --git a/_includes/deploy/providers/gae.md b/_includes/deploy/providers/gae.md
@@ -16,7 +16,7 @@ deploy:
 
 ## Status
 
-Support for deployments to Google App Engine is *stable**.
+Support for deployments to Google App Engine is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.

diff --git a/_includes/deploy/providers/gcs.md b/_includes/deploy/providers/gcs.md
@@ -27,7 +27,7 @@ deploy:
 
 ## Status
 
-Support for deployments to Google Cloud Store is *stable**.
+Support for deployments to Google Cloud Store is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment. Either `key_file` or `access_key_id` and `secret_access_key` are required.
@@ -55,4 +55,4 @@ All options can be given as environment variables if prefixed with `GCS_`.
 
 For example, `access_key_id` can be given as `GCS_ACCESS_KEY_ID=<access_key_id>`.
 
-{% include deploy/secrets.md name="access_key_id" env_name="GCS_ACCESS_KEY_ID" %}
+{% include deploy/secrets.md name="access_key_id" env_name="GCS_ACCESS_KEY_ID" %}
diff --git a/_includes/deploy/providers/heroku_api.md b/_includes/deploy/providers/heroku_api.md
@@ -16,7 +16,7 @@ deploy:
 
 ## Status
 
-Support for deployments to Heroku API is *stable**.
+Support for deployments to Heroku API is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -36,4 +36,4 @@ All options can be given as environment variables if prefixed with `HEROKU_`.
 
 For example, `api_key` can be given as `HEROKU_API_KEY=<api_key>`.
 
-{% include deploy/secrets.md name="api_key" env_name="HEROKU_API_KEY" %}
+{% include deploy/secrets.md name="api_key" env_name="HEROKU_API_KEY" %}
diff --git a/_includes/deploy/providers/lambda.md b/_includes/deploy/providers/lambda.md
@@ -18,7 +18,7 @@ deploy:
 
 ## Status
 
-Support for deployments to AWS Lambda is *stable**.
+Support for deployments to AWS Lambda is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -55,9 +55,9 @@ Use the following options to further configure the deployment.
 
 All options can be given as environment variables if prefixed with `AWS_` or `LAMBDA_`.
 
-For example, `access_key_id` can be given as 
+For example, `access_key_id` can be given as
 
-* `AWS_ACCESS_KEY_ID=<access_key_id>` or 
+* `AWS_ACCESS_KEY_ID=<access_key_id>` or
 * `LAMBDA_ACCESS_KEY_ID=<access_key_id>`
 ## Interpolation variables
 
@@ -93,4 +93,4 @@ For example: "Current build number: ${TRAVIS_BUILD_NUMBER}".
 See [here](/user/environment-variables/#default-environment-variables)
 for a list of default environment variables set.
 
-{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
+{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
diff --git a/_includes/deploy/providers/npm.md b/_includes/deploy/providers/npm.md
@@ -16,7 +16,7 @@ deploy:
 
 ## Status
 
-Support for deployments to npm is *stable**.
+Support for deployments to npm is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -42,4 +42,4 @@ All options can be given as environment variables if prefixed with `NPM_`.
 
 For example, `api_token` can be given as `NPM_API_TOKEN=<api_token>`.
 
-{% include deploy/secrets.md name="api_token" env_name="NPM_API_TOKEN" %}
+{% include deploy/secrets.md name="api_token" env_name="NPM_API_TOKEN" %}
diff --git a/_includes/deploy/providers/openshift.md b/_includes/deploy/providers/openshift.md
@@ -18,7 +18,7 @@ deploy:
 
 ## Status
 
-Support for deployments to OpenShift is *stable**.
+Support for deployments to OpenShift is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -39,4 +39,4 @@ All options can be given as environment variables if prefixed with `OPENSHIFT_`.
 
 For example, `token` can be given as `OPENSHIFT_TOKEN=<token>`.
 
-{% include deploy/secrets.md name="token" env_name="OPENSHIFT_TOKEN" %}
+{% include deploy/secrets.md name="token" env_name="OPENSHIFT_TOKEN" %}
diff --git a/_includes/deploy/providers/opsworks.md b/_includes/deploy/providers/opsworks.md
@@ -18,7 +18,7 @@ deploy:
 
 ## Status
 
-Support for deployments to AWS OpsWorks is *stable**.
+Support for deployments to AWS OpsWorks is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -43,9 +43,9 @@ Use the following options to further configure the deployment.
 
 All options can be given as environment variables if prefixed with `AWS_` or `OPSWORKS_`.
 
-For example, `access_key_id` can be given as 
+For example, `access_key_id` can be given as
 
-* `AWS_ACCESS_KEY_ID=<access_key_id>` or 
+* `AWS_ACCESS_KEY_ID=<access_key_id>` or
 * `OPSWORKS_ACCESS_KEY_ID=<access_key_id>`
 
-{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
+{% include deploy/secrets.md name="access_key_id" env_name="AWS_ACCESS_KEY_ID" %}
diff --git a/_includes/deploy/providers/pages_git.md b/_includes/deploy/providers/pages_git.md
@@ -24,7 +24,7 @@ deploy:
 
 ## Status
 
-Support for deployments to GitHub Pages is *stable**.
+Support for deployments to GitHub Pages is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment. Either `token` or `deploy_key` are required.
@@ -56,9 +56,9 @@ Use the following options to further configure the deployment. Either `token` or
 
 All options can be given as environment variables if prefixed with `GITHUB_` or `PAGES_`.
 
-For example, `token` can be given as 
+For example, `token` can be given as
 
-* `GITHUB_TOKEN=<token>` or 
+* `GITHUB_TOKEN=<token>` or
 * `PAGES_TOKEN=<token>`
 ## Interpolation variables
 
@@ -91,4 +91,4 @@ For example: "Current build number: ${TRAVIS_BUILD_NUMBER}".
 See [here](/user/environment-variables/#default-environment-variables)
 for a list of default environment variables set.
 
-{% include deploy/secrets.md name="token" env_name="GITHUB_TOKEN" %}
+{% include deploy/secrets.md name="token" env_name="GITHUB_TOKEN" %}
diff --git a/_includes/deploy/providers/pypi.md b/_includes/deploy/providers/pypi.md
@@ -17,7 +17,7 @@ deploy:
 
 ## Status
 
-Support for deployments to PyPI is *stable**.
+Support for deployments to PyPI is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment.
@@ -46,4 +46,4 @@ All options can be given as environment variables if prefixed with `PYPI_`.
 
 For example, `password` can be given as `PYPI_PASSWORD=<password>`.
 
-{% include deploy/secrets.md name="password" env_name="PYPI_PASSWORD" %}
+{% include deploy/secrets.md name="password" env_name="PYPI_PASSWORD" %}
diff --git a/_includes/deploy/providers/releases.md b/_includes/deploy/providers/releases.md
@@ -25,7 +25,7 @@ deploy:
 
 ## Status
 
-Support for deployments to GitHub Releases is *stable**.
+Support for deployments to GitHub Releases is **stable**.
 ## Known options
 
 Use the following options to further configure the deployment. Either `token` or `username` and `password` are required.
@@ -55,9 +55,9 @@ Use the following options to further configure the deployment. Either `token` or
 
 All options can be given as environment variables if prefixed with `GITHUB_` or `RELEASES_`.
 
-For example, `token` can be given as 
+For example, `token` can be given as
 
-* `GITHUB_TOKEN=<token>` or 
+* `GITHUB_TOKEN=<token>` or
 * `RELEASES_TOKEN=<token>`
 
-{% include deploy/secrets.md name="token" env_name="GITHUB_TOKEN" %}
+{% include deploy/secrets.md name="token" env_name="GITHUB_TOKEN" %}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -43,4 +43,4 @@ All options can be given as environment variables if prefixed with `ANYNINES_`.

		For example, `password` can be given as `ANYNINES_PASSWORD=<password>`.

		{% include deploy/secrets.md name="password" env_name="ANYNINES_PASSWORD" %}
		{% include deploy/secrets.md name="password" env_name="ANYNINES_PASSWORD" %}