Skip to main content
Version: 1.5.x

Changes

Overview​

The Engagespot CLI offers a set of commands to manage changes across various environments. These commands allow developers to:

  • View unpublished and published changes.
  • Publish changes from the development environment.
  • Migrate changes between environments.

This documentation details how to use these commands effectively.

Viewing Unpublished Changes​

To view all unpublished changes that have been made to workflows, use the following command:

engagespot change list --unpublished

Description:

  • Purpose: This command lists all changes that have been made but not yet published. These changes are typically still in the development or testing phase.
  • Output: The CLI will display a list of unpublished changes, including details such as the change ID, description, and date of modification.

Example:

$ engagespot change list --unpublished

Publishing Unpublished Changes​

To publish all the unpublished changes in the development environment, use the following command:

engagespot change publish -m "publish message"

Description:

  • Purpose: This command publishes all changes that are currently unpublished in the development environment. The changes will be committed with a specified message.
  • Parameters:
    • -m "publish message": A mandatory parameter that specifies the commit message for the publication.
  • Output: The CLI will confirm that the changes have been published and provide details of the operation.

Example:

$ engagespot change publish -m "Publish updated SMS template"

Publishing changes...
Changes published successfully.

Viewing Published Changes​

To view the published changes in a specific environment, use the following command:

engagespot change list --published --environment="staging"

Description:

  • Purpose: This command lists all the changes that have been published in a specified environment.
  • Parameters:
    • --published: Indicates that only published changes should be listed.
    • --environment="staging": Specifies the environment for which the published changes should be listed. Replace "staging" with the desired environment name (e.g., "production", "development").
  • Output: The CLI will display a list of published changes in the specified environment.

Example:

$ engagespot change list --published --environment="staging"

Migrating Changes Between Environments​

To migrate changes from one environment to another, use the following command:

engagespot change migrate --from="development" --to="production"

Description:

  • Purpose: This command migrates changes from a source environment to a target environment.
  • Parameters:
    • --from="development": Specifies the source environment where the changes currently exist.
    • --to="production": Specifies the target environment where the changes should be migrated.
  • Output: The CLI will confirm the migration of changes between the specified environments.

Example:

$ engagespot change migrate --from="development" --to="production"

Migrating changes from development to production...
Migration completed successfully.

Example Scenarios​

  1. Scenario: Reviewing Changes Before Publishing

    • Use engagespot change list --unpublished to review all changes that have been made but not yet published.

  2. Scenario: Publishing a Set of Changes

    • After reviewing, publish the changes with engagespot change publish -m "Release new features" to move them from unpublished to published status in the development environment.

  3. Scenario: Viewing the Current State of a Staging Environment

    • Run engagespot change list --published --environment="staging" to see all the changes currently active in the staging environment.

  4. Scenario: Promoting Changes to Production

    • Use engagespot change migrate --from="staging" --to="production" to promote fully tested changes from staging to production.