Chef Supermarket Deployment

This page documents deployments using the next major version dpl v2, which currently is in a beta release phase. Please see our blog post for details. The current default version is dpl v1. Check dpl v1 documentation here.

Be sure to read the v2 deployment overview.

Status
Known options
Pull Requests
See also

Travis CI can automatically deploy your cookbook to Chef Supermarket after a successful build.

For a minimal configuration, add the following to your .travis.yml:

deploy:
  provider: chef_supermarket
  user_id: <user_id>
  category: <category>
  edge: true # opt in to dpl v2

Encrypt your client key by running the following command and add it to your .travis.yml file:

  travis encrypt-file client.pem

See Encrypting Files for instructions on adding encrypted files to your repository and .travis.yml file.

Status #

Support for deployments to Chef Supermarket is in alpha. Please see Maturity Levels for details.

Known options #

Use the following options to further configure the deployment.

`user_id`	Chef Supermarket user name — required, type: string
`name`	Cookbook name — type: string, alias: `cookbook_name` (deprecated, please use `name`), note: defaults to the name given in metadata.json or metadata.rb
`category`	Cookbook category in Supermarket — required, type: string, alias: `cookbook_category` (deprecated, please use `category`), see: https://docs.getchef.com/knife_cookbook_site.html#id12
`client_key`	Client API key file name — type: string, default: `client.pem`
`dir`	Directory containing the cookbook — type: string, default: `.`

Shared options #

`cleanup`	Clean up build artifacts from the Git working directory before the deployment — type: boolean
`run`	Commands to execute after the deployment finished successfully — type: string or array of strings

Pull Requests #

Note that pull request builds skip the deployment step altogether.