checkly / checkly/checkly-cli

feat: Deploy preview with details which data is going to be updated for each file changed (similar to terraform plan command)

Open
#993 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
96
Forks
25
Avg merge
14h 14m
Merged PRs (30d)
38

Description

What problem does this feature solve?

Before deploying changes to the cloud, it’s beneficial to preview what changes will be submitted. This is similar to the terraform plan command.

While there is a preview flag for npx checkly deploy -p, it only provides a list of logicalIds without showing the exact content of the changes. Without these details, it becomes difficult to understand what will be updated in the cloud, as demonstrated in the image below:
image

Ideally, a standalone command like npx checkly preview would be available for previews, similar to:

terraform plan
cdk diff
pulumi preview
How would you implement this feature?

Proposed Implementation Steps:

  1. Retrieve the current data from the server via API.

  2. Gather the data to be sent to the API.

  3. Compare the differences and display them in the CLI in a format that clearly shows the current values and the proposed updates for easy understanding.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining the existing npx checkly deploy -p preview path, then trace how current data is retrieved from the server and how deployment data is gathered for the API. The work is done when a preview command clearly displays current values and proposed updates for each changed file or resource.

Written by the indexing model from the issue text.

Assessment

Tech stack
nodejs, typescript
Domain
api, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.