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

Prefect yaml triggers add description. #16944

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jeanluciano
Copy link
Contributor

Adds the description to automations from triggers specified in the prefect.yaml.

closes: #16655

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.
  • If this pull request adds new functionality, it includes unit tests that cover the changes
  • If this pull request removes docs files, it includes redirect settings in mint.json.
  • If this pull request adds functions or classes, it includes helpful docstrings.

@github-actions github-actions bot added the enhancement An improvement of an existing feature label Feb 3, 2025
Copy link

codspeed-hq bot commented Feb 3, 2025

CodSpeed Performance Report

Merging #16944 will not alter performance

Comparing jean/oss-6107-propagate-trigger-descriptions-from-prefect-yaml (bc87d01) with main (20b074c)

Summary

✅ 2 untouched benchmarks

@jeanluciano jeanluciano marked this pull request as ready for review February 4, 2025 16:19
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.

nice! could you add one more test that confirms the description makes it to the API? (or augment an existing test)

@github-actions github-actions bot added the ui-replatform Related to the React UI rewrite label Feb 4, 2025
@@ -5815,6 +5818,7 @@ async def test_yaml_file_trigger(self, docker_work_pool):

trigger_spec = {
"enabled": True,
"description": "This is a test trigger",
Copy link
Member

Choose a reason for hiding this comment

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

These only test the description is included in the client-side payload sent to the server, they don't test that the server receives and stores the description; maybe adding a non-trivial description field to this test would do the trick: https://github.com/PrefectHQ/prefect/blob/main/tests/events/server/models/test_automations.py#L176

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 ui-replatform Related to the React UI rewrite
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Propagate Trigger descriptions from prefect yaml
2 participants