Puppet Forge 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.

Travis CI can automatically deploy your modules to Puppet Forge or to your own Forge instance after a successful build.

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

deploy:
  provider: puppetforge
  username: <username>
  password: <encrypted password>
  edge: true # opt in to dpl v2

Status #

Support for deployments to Puppet Forge is in alpha. Please see Maturity Levels for details.

Known options #

Use the following options to further configure the deployment.

username Puppet Forge user name — required, type: string, alias: user
password Puppet Forge password — required, secret, type: string
url Puppet Forge URL to deploy to — type: string, default: https://forgeapi.puppetlabs.com/

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

Environment variables #

All options can be given as environment variables if prefixed with PUPPETFORGE_.

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

Securing secrets #

Secret option values should be given as either encrypted strings in your build configuration (.travis.yml file) or environment variables in your repository settings.

Environment variables can be set on the settings page of your repository, or using travis env set:

travis env set PUPPETFORGE_PASSWORD <password>

In order to encrypt option values when adding them to your .travis.yml file use travis encrypt:

travis encrypt <password>

Or use --add to directly add it to your .travis.yml file. Note that this command has to be run in your repository’s root directory:

travis encrypt --add deploy.password <password>

Deploying to a custom Forge #

To deploy to your own hosted Forge instance by adding it in the url key:

deploy:
  provider: puppetforge
  # ⋮
  url: https://forgeapi.example.com/

Pull Requests #

Note that pull request builds skip the deployment step altogether.

See also #