Skip to content
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

Deprecate Deployment class and deployment build and apply commands #12283

Merged
merged 5 commits into from Mar 13, 2024

Conversation

desertaxle
Copy link
Member

@desertaxle desertaxle commented Mar 13, 2024

Adds a deprecation warning to the Deployment class along with the the deployment build and apply commands in lieu of flow.deploy and prefect deploy. Adds some logic to enable deprecation of specific commands in addition to full command groups.

Example

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • This pull request includes tests or only affects documentation.
  • This pull request includes a label categorizing the change e.g. maintenance, fix, feature, enhancement, docs.

For documentation changes:

  • This pull request includes redirect settings in netlify.toml for files that are removed or renamed.

For new functions or classes in the Python SDK:

  • This pull request includes helpful docstrings.
  • If a new Python file was added, this pull request contains a stub page in the Python SDK docs and an entry in mkdocs.yml navigation.

@desertaxle desertaxle added the deprecation This feature has been marked for removal label Mar 13, 2024
Copy link

netlify bot commented Mar 13, 2024

Deploy Preview for prefect-docs-preview ready!

Name Link
🔨 Latest commit 38a5964
🔍 Latest deploy log https://app.netlify.com/sites/prefect-docs-preview/deploys/65f21321d2f6b700084c4781
😎 Deploy Preview https://deploy-preview-12283--prefect-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@desertaxle desertaxle marked this pull request as ready for review March 13, 2024 19:25
@desertaxle desertaxle requested a review from a team as a code owner March 13, 2024 19:25
Copy link
Contributor

@serinamarie serinamarie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow I didn't really realize these would be deprecated as well. Would it make sense to add a blurb in the description on the motivation? I feel like this will be a frequently viewed PR 👀 and it could be useful for anyone wondering about it.

" Refer to the upgrade guide for more information"
),
):
Deployment(name="foo")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤯

src/prefect/deployments/deployments.py Outdated Show resolved Hide resolved
src/prefect/deployments/deployments.py Outdated Show resolved Hide resolved
desertaxle and others added 2 commits March 13, 2024 15:56
Co-authored-by: Serina Grill <42048900+serinamarie@users.noreply.github.com>
Co-authored-by: Serina Grill <42048900+serinamarie@users.noreply.github.com>
@desertaxle
Copy link
Member Author

Wow I didn't really realize these would be deprecated as well. Would it make sense to add a blurb in the description on the motivation? I feel like this will be a frequently viewed PR 👀 and it could be useful for anyone wondering about it.

We'll have an explanation in the release notes tomorrow that will cover the motivation behind these deprecations. I updated the description of this PR slightly, but I can add more detail tomorrow while working on a release notes highlight.

@desertaxle desertaxle merged commit ab79bc5 into main Mar 13, 2024
40 checks passed
@desertaxle desertaxle deleted the deprecate/deployment branch March 13, 2024 21:02
@serinamarie
Copy link
Contributor

Awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation This feature has been marked for removal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants