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.

Sign up for GitHub

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

Jump to bottom

Update deployment docs to include tag and idempotency key #7771

Merged
merged 4 commits into from
Jan 7, 2023
Merged

Update deployment docs to include tag and idempotency key #7771

merged 4 commits into from
Jan 7, 2023

Conversation

riquelmev
Copy link
Contributor

@riquelmev riquelmev commented Dec 5, 2022 •
edited
Loading

Added docstring documentation about deployment tags and idempotency key to deployments.py.
Original request: #7522
Although #7641 fixed the issue, no documentation was added, hence this pr.

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
  • This pull request includes tests or only affects documentation.
  • This pull request includes a label categorizing the change e.g. fix, feature, enhancement

@netlify
Copy link

netlify bot commented Dec 5, 2022 •
edited
Loading

✅ Deploy Preview for prefect-orion ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 0cae4fc
🔍 Latest deploy log https://app.netlify.com/sites/prefect-orion/deploys/6394fe8158d93800081336d7
😎 Deploy Preview https://deploy-preview-7771--prefect-orion.netlify.app/api-ref/prefect/deployments
📱 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 settings.

kevin868
kevin868 reviewed Dec 8, 2022
View reviewed changes
src/prefect/deployments.py Outdated
@@ -73,7 +73,7 @@ async def run_deployment(
Defaults to None
poll_interval: The number of seconds between polls
tags: An optional list of tags to associate with this flow run; note that tags are used only for organizational purposes.
idempotency_key: q unique value to be used by the server to recognize subsequent retries of the same run.
idempotency_key: a unique value to be used by the server to recognize subsequent retries of the same run.
Copy link
Contributor

Choose a reason for hiding this comment

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

capitalization and making things more concise
A unique value to recognize retries of the same run, and prevent creating multiple flow runs.

src/prefect/deployments.py Outdated
@@ -72,6 +72,8 @@ async def run_deployment(
Setting `timeout` to None will allow this function to poll indefinitely.
Defaults to None
poll_interval: The number of seconds between polls
tags: An optional list of tags to associate with this flow run; note that tags are used only for organizational purposes.
Copy link
Contributor

Choose a reason for hiding this comment

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

You can remove 'optional' here.. as many of these params are, without explicitly saying so.

Also consider adding in this PR, Optional[type] tags above to each of the items with defaults (Everything but name). but this style should be something the Prefect team should weigh in on. It's nice but also clutters readability.

@riquelmev riquelmev marked this pull request as ready for review December 10, 2022 21:48
@riquelmev riquelmev requested a review from cicdw as a code owner December 10, 2022 21:48
cicdw
cicdw approved these changes Jan 7, 2023
View reviewed changes
Copy link
Member

@cicdw cicdw left a comment

Choose a reason for hiding this comment

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

Thank you!

@cicdw cicdw merged commit 88c896a into PrefectHQ:main Jan 7, 2023
ddelange added a commit to ddelange/prefect that referenced this pull request Jan 9, 2023
@ddelange
Merge branch 'main' of https://github.com/ddelange/prefect into docke…
b8283f3 
…r-builds-release

* 'main' of https://github.com/ddelange/prefect: (131 commits)
  Fix docker-builds.yaml templating syntax (PrefectHQ#8114)
  Rename Worker pools -> work pools (PrefectHQ#8107)
  Build multi-arch images for commits on main (PrefectHQ#7900)
  [Issue PrefectHQ#456] Change example of `infra_override` in docs/concepts/deployment (PrefectHQ#8101)
  Bump @playwright/test from 1.29.1 to 1.29.2 in /orion-ui (PrefectHQ#8105)
  Bump @prefecthq/orion-design from 1.1.53 to 1.1.54 in /orion-ui (PrefectHQ#8104)
  Update deployment docs to include tag and idempotency key (PrefectHQ#7771)
  Add `BaseWorker` and `ProcessWorker` (PrefectHQ#7996)
  Add Peyton and Serina as global code owners (PrefectHQ#8098)
  Add release notes for 2.7.7 (PrefectHQ#8091)
  Add youtube badge (PrefectHQ#8089)
  Adds `MAX_RRULE_LENGTH` (PrefectHQ#7762)
  Limit task run cache key size (PrefectHQ#7275)
  Add --match flag to work queues documentation (PrefectHQ#7768)
  Modify disable ssl setting tests to allow any for headers and timeout (PrefectHQ#8086)
  Add test for allow_failure and quote (PrefectHQ#8055)
  Adds `experimental_field` decorator (PrefectHQ#8066)
  add docs on migrating block documents (PrefectHQ#8085)
  Add Redoc documentation for REST API reference (PrefectHQ#7503)
  Allow disabling SSL verification (PrefectHQ#7850)
  ...
ddelange added a commit to ddelange/prefect that referenced this pull request Jan 9, 2023
@ddelange
Merge branch 'docker-builds-release' of https://github.com/ddelange/p…
e300821 
…refect into docker-builds-consolidation

* 'docker-builds-release' of https://github.com/ddelange/prefect: (131 commits)
  Fix docker-builds.yaml templating syntax (PrefectHQ#8114)
  Rename Worker pools -> work pools (PrefectHQ#8107)
  Build multi-arch images for commits on main (PrefectHQ#7900)
  [Issue PrefectHQ#456] Change example of `infra_override` in docs/concepts/deployment (PrefectHQ#8101)
  Bump @playwright/test from 1.29.1 to 1.29.2 in /orion-ui (PrefectHQ#8105)
  Bump @prefecthq/orion-design from 1.1.53 to 1.1.54 in /orion-ui (PrefectHQ#8104)
  Update deployment docs to include tag and idempotency key (PrefectHQ#7771)
  Add `BaseWorker` and `ProcessWorker` (PrefectHQ#7996)
  Add Peyton and Serina as global code owners (PrefectHQ#8098)
  Add release notes for 2.7.7 (PrefectHQ#8091)
  Add youtube badge (PrefectHQ#8089)
  Adds `MAX_RRULE_LENGTH` (PrefectHQ#7762)
  Limit task run cache key size (PrefectHQ#7275)
  Add --match flag to work queues documentation (PrefectHQ#7768)
  Modify disable ssl setting tests to allow any for headers and timeout (PrefectHQ#8086)
  Add test for allow_failure and quote (PrefectHQ#8055)
  Adds `experimental_field` decorator (PrefectHQ#8066)
  add docs on migrating block documents (PrefectHQ#8085)
  Add Redoc documentation for REST API reference (PrefectHQ#7503)
  Allow disabling SSL verification (PrefectHQ#7850)
  ...
masonmenges pushed a commit that referenced this pull request Jan 10, 2023
@riquelmev @masonmenges
Update deployment docs to include tag and idempotency key (#7771)
93e1eb7 
Co-authored-by: vicente <vicente@getbluesky.io>
github-actions bot pushed a commit that referenced this pull request Jan 12, 2023
@riquelmev @madkinsz
Update deployment docs to include tag and idempotency key (#7771)
b83b2c0 
Co-authored-by: vicente <vicente@getbluesky.io>
github-actions bot pushed a commit that referenced this pull request Jan 12, 2023
@riquelmev @github-actions
Update deployment docs to include tag and idempotency key (#7771)
53edf6c 
Co-authored-by: vicente <vicente@getbluesky.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevin868 kevin868 kevin868 left review comments

@cicdw cicdw cicdw approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@riquelmev @cicdw @kevin868