Skip Navigation
Show nav
Heroku Dev Center
  • Get Started
  • Documentation
  • Changelog
  • Search
  • Get Started
    • Node.js
    • Ruby on Rails
    • Ruby
    • Python
    • Java
    • PHP
    • Go
    • Scala
    • Clojure
  • Documentation
  • Changelog
  • More
    Additional Resources
    • Home
    • Elements
    • Products
    • Pricing
    • Careers
    • Help
    • Status
    • Events
    • Podcasts
    • Compliance Center
    Heroku Blog

    Heroku Blog

    Find out what's new with Heroku on our blog.

    Visit Blog
  • Log inorSign up
View categories

Categories

  • Heroku Architecture
    • Dynos (app containers)
    • Stacks (operating system images)
    • Networking & DNS
    • Platform Policies
    • Platform Principles
  • Command Line
  • Deployment
    • Deploying with Git
    • Deploying with Docker
    • Deployment Integrations
  • Continuous Delivery
    • Continuous Integration
  • Language Support
    • Node.js
    • Ruby
      • Working with Bundler
      • Rails Support
    • Python
      • Background Jobs in Python
      • Working with Django
    • Java
      • Working with Maven
      • Java Database Operations
      • Java Advanced Topics
      • Working with Spring Boot
    • PHP
    • Go
      • Go Dependency Management
    • Scala
    • Clojure
  • Databases & Data Management
    • Heroku Postgres
      • Postgres Basics
      • Postgres Getting Started
      • Postgres Performance
      • Postgres Data Transfer & Preservation
      • Postgres Availability
      • Postgres Special Topics
    • Heroku Data For Redis
    • Apache Kafka on Heroku
    • Other Data Stores
  • Monitoring & Metrics
    • Logging
  • App Performance
  • Add-ons
    • All Add-ons
  • Collaboration
  • Security
    • App Security
    • Identities & Authentication
    • Compliance
  • Heroku Enterprise
    • Private Spaces
      • Infrastructure Networking
    • Enterprise Accounts
    • Enterprise Teams
    • Heroku Connect (Salesforce sync)
      • Heroku Connect Administration
      • Heroku Connect Reference
      • Heroku Connect Troubleshooting
    • Single Sign-on (SSO)
  • Patterns & Best Practices
  • Extending Heroku
    • Platform API
    • App Webhooks
    • Heroku Labs
    • Building Add-ons
      • Add-on Development Tasks
      • Add-on APIs
      • Add-on Guidelines & Requirements
    • Building CLI Plugins
    • Developing Buildpacks
    • Dev Center
  • Accounts & Billing
  • Troubleshooting & Support
  • Integrating with Salesforce
  • Continuous Delivery
  • Pipelines

Pipelines

English — 日本語に切り替える

Last updated January 19, 2023

Table of Contents

  • Creating pipelines
  • Accessing pipelines
  • Adding apps to a pipeline
  • Deployment with pipelines
  • Pipelines ownership and transfer
  • GitHub Sync
  • Review apps
  • Pipelines and Heroku CI
  • Ephemeral app permissions
  • Design considerations
  • FAQ

A pipeline is a group of Heroku apps that share the same codebase. Each app in a pipeline represents one of the following stages in a continuous delivery workflow:

  • Development
  • Review
  • Staging
  • Production

Pipelines are extremely useful for managing multiple environments for your app. A common pipeline workflow has the following steps:

  1. A developer creates a pull request to make a change to the codebase.
  2. Heroku automatically creates a review app for the pull request, allowing developers to test the change.
  3. When the change is ready, it’s merged into the codebase’s master branch.
  4. The master branch is automatically deployed to the pipeline’s staging app for further testing.
  5. When the change is ready, a developer promotes the staging app to production, making it available to the app’s end users.

A pipeline’s overview page illustrates the stages of this flow and provides meta-information about the status of each stage. For example, you can see if your production app is running different code than staging.

Example pipeline

Creating pipelines

From the Heroku Dashboard

Click the New button in the top right of your app list and select Create new pipeline:

Create pipeline from app list

Alternatively, you can navigate to an app’s Deploy tab and create a new pipeline to include that app.

Create pipeline from app

From the Heroku CLI

You can use the pipelines:create command to create a pipeline from the CLI. Note that the command must specify an existing app that you want to add to the pipeline.

$ heroku pipelines:create -a example-app
? Pipeline name: example-pipeline
? Stage of example-app: production
Creating example-pipeline pipeline... done
Adding example-app to example-pipeline pipeline as production... done

The CLI prompts you to specify a name for the pipeline and a stage for the app you’re adding to it (development, staging, or production).

Use heroku help pipelines:create to see a full list of options for this command.

Accessing pipelines

Apps in a pipeline do not appear as individual apps in the Heroku Dashboard. Instead, they appear as part of a single pipeline entry with a drop-down to view individual apps:

Pipelines in app list

Adding apps to a pipeline

A Heroku app can belong to exactly one stage of exactly one pipeline.

From the Heroku Dashboard

From your pipeline’s overview page, click + Add app next to a deployment stage to add an existing application to that stage of the pipeline.

From the Heroku CLI

Add an app to your pipeline with the heroku pipelines:add command:

$ heroku pipelines:add example-pipeline -a example-staging-app
? Stage of example-staging: staging
Adding example-staging to example pipeline as staging... done

Multiple apps in a pipeline stage

Pipeline stages can include more than one app. For example, the production stage might have the main production app and an admin app running the same version of code, but with different configurations.

Multiple production apps

Deployment with pipelines

Pipelines let you define how your deployed code flows from one environment to the next. For example, you can deploy code to your staging app (which builds it into a slug) and later promote that same slug to production. This promotion flow ensures that production contains the exact same code that you tested in staging, and it’s also much faster than rebuilding the slug.

Promoting

After you’ve fully tested a change in a particular pipeline stage, you can promote its associated slug to the app(s) in the downstream stage.

Downstream refers to the next environment stage in a pipeline. For example, given a development --> staging --> production pipeline, staging is downstream of development, and production is downstream of staging.

From the Heroku Dashboard

You promote a particular stage’s slug by clicking its associated Promote button on your pipeline’s overview page:

Pipeline promotion

If there are multiple apps in the downstream stage, you can specify which ones you want to promote the slug to.

The Promote button will only be available if there are apps in the subsequent stage(s). In other words, if staging has an app to be promoted to production but the production stage doesn’t contain any apps, there will be nothing in which to promote the staging app, and thus no promotion target.

From the Heroku CLI

From the CLI, you can promote a slug with the heroku pipelines:promote command. The command must specify the name (-a) or Git remote (-r) of the source app:

$ heroku pipelines:promote -r staging
Promoting example-staging to example (production)... done, v23
Promoting example-staging to example-admin (production)... done, v54

By default, this command promotes the source app’s slug to all apps in the downstream stage. You can specify a subset of these apps to promote to with the --to option:

$ heroku pipelines:promote -r staging --to my-production-app1,my-production-app2
Starting promotion to apps: my-production-app1,my-production-app2... done
Waiting for promotion to complete... done
Promotion successful
my-production-app1: succeeded
my-production-app2: succeeded

Release phase during a promotion

Release Phase does run when you promote a slug, despite the fact that no new build is created.

Pipelines ownership and transfer

Pipelines setting tab ownership segment

The Pipelines web interface and CLI encourage (and will eventually require) that apps in a Pipeline be owned by the Pipeline owner. This owner can be assigned in the Settings tab of the Pipelines web interface.

Electing to assign a Pipeline owner, typically a Heroku Team, will prevent common permissions-related issues in collaborative workflows. This is especially important when owners wish to assign team members differing access to production, staging, and development apps.

This feature encourages better structure and administrative hierarchy in Pipelines.

A user is eligible to own a Pipeline if the user owns app(s) in a Pipeline. Once a user assumes ownership of the Pipeline, the web UI will highlight Pipeline apps not owned by that user and provide a UI to transfer the foreign apps in the Pipeline to the Pipeline owner.

Pipelines owned by an individual can only be transferred to a Heroku Team (or Enterprise Team) in which that individual are an member. Team-owned Pipelines can be transferred to any individual that is a member of that Team. However, for billing security, individual Pipelines cannot be transferred directly to other individuals.

GitHub Sync

Promoting from staging to production is great, but you can further optimize your flow by automatically deploying to staging using GitHub integration. For example, whenever the master branch is updated on GitHub and continuous integration (CI) tests pass, staging can be auto-deployed.

Review apps

If you’re using GitHub, we highly recommend using pull requests and setting up corresponding review apps. Dynos and add-ons used by review apps are charged in exactly the same way as for normal apps. See Review App Management and Costs for more info.

Pipelines and Heroku CI

If you’re using GitHub, you can turn on Heroku CI, Heroku’s visual, low-configuration test runner that integrates easily with Heroku Pipelines. Any Heroku Pipeline is already CI-ready – just turn it on in the pipeline’s Settings tab. Heroku CI costs $10 per month per pipeline.

Ephemeral app permissions

The pipeline access tab can only be used to manage Review Apps access for users of the new Review Apps. If you are using the older version of Review Apps please upgrade to the new version to use this feature. If you have CI enabled, the pipeline access tab can be used to manage user permissions on CI apps whether you are using the new version of Review Apps or the old version.

Review apps and CI apps are short-lived, “ephemeral” apps. You can set user permissions and manage access to all ephemeral apps within a pipeline via the pipeline’s access tab. The access tab is available to “admin” users in Heroku Teams and Enterprise Teams, and to pipeline owners in personal accounts.

Permissions in the pipeline access tab are only applied to review apps and CI apps.

With the new version of Review Apps, all users with “member” role in the Enterprise Teams and Heroku Teams were automatically added to Review Apps via auto-join with “View”, “Operate” and “Deploy” permissions. The pipelines access tab makes it possible to manage and modify auto-join access. Modifying auto-join permissions are only possible for Enterprise Teams. For Heroku Teams, the “View”, “Operate” and “Deploy” permissions that “members” get via auto-join are static and can’t change.

To edit permission for existing pipelines in an Enterprise Team, select the small pencil icon in the “Default permissions for new team members” section of the pipeline access tab. You can also disable auto-join completely. Permission changes and turning off/on auto-join will only be effective for new apps and doesn’t change previous settings.

Edit auto join

Auto-join is when users with “member” role in the Enterprise Team and Heroku Teams are automatically added to the pipeline with “View”, “Operate” and “Deploy” permissions on Review Apps and CI Apps. Via the pipeline access tab, you can disable auto-join, or modify auto-join permissions for Enterprise Team “members”. For Heroku Teams, permissions are static and can’t change.

 

Any changes to user permissions in the pipeline access tab, turning on and off auto-join, and editing exiting auto-join permissions will only be applied to new apps from the time you make those changes. They won’t be applied to existing apps.

For new pipelines, the default is set to auto-join enabled with “View”, “Operate” and “Deploy” permissions selected. You can turn auto-join off or modify permissions when creating the pipeline.

Auto join new

For all other users that are not added automatically via auto-join, you can add them manually. As an example, if you want a “collaborator” user to have “operate” access to the Review Apps and CI Apps within the pipeline, add the user manually under the pipeline access tab with “operate” permission selected.

Auto join new

For Heroku Teams, permissions are static and can’t be modified, so there are no options to select permissions when enabling auto-join:

Static permissions

And no options to edit existing user permissions. User’s get pre-set static permissions based on their role in the team:

Static permissions

For personal accounts there is no concept of auto-join since there is no higher team layer, but each pipeline has the access tab via which you can add users that you want to have access to Review Apps and CI Apps within the pipeline:

Static permissions

Permissions and capabilities

While pipeline level permissions look the same as Heroku app permissions, their capabilities are different and specific to actions users can take on Review Apps and CI Apps.

Only users with “admin” role in Enterprise Teams and Online Teams, and pipeline owners in personal account can access and modify pipeline level permissions.

Action  View  DeployOperateManage
Review Apps
View pull requestsXXXX
View Review AppsXXXX
Open Review AppsXXXX
Create Review AppsXXXX
Delete Review AppsXXXX
See build information XXX
Edit config vars XXX
CI
View testsXXXX
Create CI apps  XX
Enable CI   X
Cancel CI runs   X

Design considerations

Pipelines manage the flow of application slugs only. Your app’s Git repo, config vars, add-ons, and other environmental dependencies must be managed independently.

Deploying via pipeline promotion is recommended only for apps with stateless builds. Builds that compile configuration variable values into the slug (i.e., stateful builds) can encounter issues when promoted. For apps with stateful builds, use Heroku’s standard Git-based deployment or GitHub deploys instead.

When a slug is promoted, Heroku copies it without making any changes. It is not rebuilt for the environment of the target app. If your builds bake in environment from the build-app context, then your slugs are not portable between pipeline stages. This may be the case, for example, if you’re using Ruby on Rails and the asset pipeline to build assets hosted at a CDN defined by a URL in your build environment. This is because URLs specific to the build-app will be baked into css and js-files, and those will not work correctly when promoted. Please see this article for instructions on how to configure this with Rails.

Slugs are associated with the stack on which they were built, since they typically contain binaries compiled against the system libraries in that stack. As such, promoting a slug from one app to another will update the stack of the target app to match that of the originating app.

FAQ

What else can I do with the pipelines CLI?

A complete list of Pipelines commands with usage details is available in the console:

$ heroku help pipelines

The repository README for the Heroku CLI plugin provides additional usage examples and a feature history.

Can I have pipelines stages other than development, staging and production?

No, only those three stages are currently supported, plus the special stage, review.

Can I run scripts, such as rake db:migrate when promoting?

Heroku Release Phase lets you perform common tasks like schema migrations before a new version of your app is deployed to any step of the continuous delivery flow. See its documentation for more information.

Can I have more than one app in a pipeline stage?

Yes.

Do pipelines always require a app?

Yes, pipelines require to always contain one application. Pipelines that do not contain any apps are not accessible via our dashboard and will be scheduled to be deleted. It is highly recommended you have at least one permanent app in your pipeline as you cannot always guarantee that a review app will exist within the pipeline.

Do pipelines work without GitHub?

Yes. Pipelines are very well integrated with GitHub, but this integration is not required.

I don’t see a “development” stage, how do I add a development app?

You can add the app to any other stage, and then using the context menu on the app card, move the app to “development”. Alternatively, you can go to the Deploy tab of the app and add it to a pipeline from there, while specifying the “development” stage.

Do Pipelines work with Heroku Enterprise Teams?

Yes, Pipelines are fully supported for Enterprise Teams. However, in some cases team members may find they cannot operate on a given app in a pipeline due to the access control, such as that described in Using App Permissions in Heroku Enterprise Teams. Users must have adequate permissions to perform the relevant operations on the app.

Do Pipelines work with Private Spaces?

Yes, a Pipeline can span apps in the Common Runtime and in multiple different Private Spaces. This allows you to have test and staging apps in the Common Runtime or in a separate Private Space while promoting to a Private Space with only production apps.

How much do Pipelines cost?

While the use of the Pipelines feature itself is free, you still incur costs for any dynos or add-ons used by your apps in the pipeline. In addition, if you have Heroku CI enabled, you’re charged $10 per month per pipeline.

Keep reading

  • Continuous Delivery

Feedback

Log in to submit feedback.

Review Apps (Old) Preboot

Information & Support

  • Getting Started
  • Documentation
  • Changelog
  • Compliance Center
  • Training & Education
  • Blog
  • Podcasts
  • Support Channels
  • Status

Language Reference

  • Node.js
  • Ruby
  • Java
  • PHP
  • Python
  • Go
  • Scala
  • Clojure

Other Resources

  • Careers
  • Elements
  • Products
  • Pricing

Subscribe to our monthly newsletter

Your email address:

  • RSS
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku Blog
    • Heroku News Blog
    • Heroku Engineering Blog
  • Heroku Podcasts
  • Twitter
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku
    • Heroku Status
  • Facebook
  • Instagram
  • Github
  • LinkedIn
  • YouTube
Heroku is acompany

 © Salesforce.com

  • heroku.com
  • Terms of Service
  • Privacy
  • Cookies
  • Cookie Preferences