Skip to content

Add a --dry-run switch or equivalent to prefect deploy #17814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tjordahl opened this issue Apr 14, 2025 · 2 comments · May be fixed by #18159
Open

Add a --dry-run switch or equivalent to prefect deploy #17814

tjordahl opened this issue Apr 14, 2025 · 2 comments · May be fixed by #18159
Labels
enhancement An improvement of an existing feature

Comments

@tjordahl
Copy link

tjordahl commented Apr 14, 2025

Describe the current behavior

My continuous integration/deployment fails when there is a problem in the prefect.yaml file and I would like something to be able to validate all the entries so this can be done before the changes are merged and attempted to be deployed.

The current prefect deploy --all will deploy all flows up until it encounters an error, then stop. This leaves my Depoyments in a state of half new, half old deployments.

Describe the proposed behavior

In addition to validating the YAML schema for prefect.yaml, this should catch items such as:

  • Invalid parameter values
  • Incorrect endpoint specifications (missing file/function)
  • Other validation

In short, everything but the POST /deployment operation. A --dry-run switch to prefect deploy would be ideal

Example Use

prefect deploy --all --dry-run

Additional context

Slack thread: https://prefect-community.slack.com/archives/CL09KU1K7/p1744654952403849
Relevant issue: #16996

@tjordahl tjordahl added the enhancement An improvement of an existing feature label Apr 14, 2025
@tjordahl
Copy link
Author

tjordahl commented May 5, 2025

Just wanted to ping on this - any plans to implement soon(ish)?
We keep getting caught with bad deployment config which leaves our server with partially updated deployments as everything above any error deploys successfully and anything below doesn't get run.

@cicdw
Copy link
Member

cicdw commented May 7, 2025

We are interested in this feature but I don't have a timeline to share on when we will be able to pick it up. We would also accept a PR if you have the energy to do that!

@zzstoatzz zzstoatzz linked a pull request May 23, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An improvement of an existing feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants