Skip to main content

Manage releases with the CLI

This topic describes how to use the Replicated CLI to create and promote releases.

For information about creating and managing releases with the Vendor Portal, see Manage Releases with the Vendor Portal.

For information about creating and managing releases with the Vendor API v3, see the releases section in the Vendor API v3 documentation.

Prerequisites​

Before you create a release using the Replicated CLI, complete the following prerequisites:

  • Install the Replicated CLI then authenticate with your Replicated credentials. See Install the Replicated CLI.

  • If you do not yet have an application in the Replicated Platform, create a new application using the replicated app create APP_NAME command. See app create in Reference.

  • Set the REPLICATED_APP environment variable to the slug of the target application. See Set Environment Variables in Installing the Replicated CLI.

    Example:

    export REPLICATED_APP=my-app-slug

Create and promote a release​

You can use the Replicated CLI to create a release from a local directory that contains the release files.

To create and promote a release:

  1. Lint your release files:

    replicated release lint --yaml-dir=PATH_TO_RELEASE_DIR

    Where PATH_TO_RELEASE_DIR is the path to the directory with the release files.

    For more information, see release lint and Linter Rules.

  2. Do one of the following:

    • Create and promote the release with one command:

      replicated release create --yaml-dir PATH_TO_RELEASE_DIR --lint --promote CHANNEL

      Where:

      • PATH_TO_RELEASE_DIR is the path to the directory with the release files.
      • CHANNEL is the channel ID or the case sensitive name of the channel.

      For a complete list of options for the command, see release create.

    • Create and edit the release before promoting:

      1. Create the release:

        replicated release create --yaml-dir PATH_TO_RELEASE_DIR

        Where PATH_TO_RELEASE_DIR is the path to the directory with the release files.

        For more information, see release create.

      2. Edit and update the release as desired:

        replicated release update SEQUENCE --yaml-dir PATH_TO_RELEASE_DIR

        Where:

        • SEQUENCE is the release sequence number. This identifies the existing release to be updated.
        • PATH_TO_RELEASE_DIR is the path to the directory with the release files.

        For more information, see release update.

      3. Promote the release when you are ready to test it. Releases cannot be edited after they are promoted. To make changes after promotion, create a new release.

        replicated release promote SEQUENCE CHANNEL

        Where:

        • SEQUENCE is the release sequence number.
        • CHANNEL is the channel ID or the case sensitive name of the channel.

        For more information, see release promote.

On this page