Add helper method to quickly create run template from pipeline

[schustmi]

Describe changes

This PR adds a small helper method to create a run template for a pipeline without running it first:

@pipeline
def my_pipeline():
  ...

template = my_pipeline.create_run_template(name="template_name")

This can be useful in CI scenarios, where only a template should be created for later runs instead of running it immediately.

Pre-requisites

Please ensure you have done the following:

• I have read the CONTRIBUTING.md document.
• If my change requires a change to docs, I have updated the documentation accordingly.
• I have added tests to cover my changes.
• I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
• If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Other (add details above)

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[bcdurak]

When I tried to test this, I ran into some stuff that I was not expecting:

1. I forgot to switch to a remote stack and I got this error:

ValueError: Unable to create run template as there is no associated build.

While I understand where this is coming from, the new users might be a bit confused due to the message here. Maybe we can add something like: Make sure you have an active remote stack..

2. When I tried to use the same name for the template, I got the error:

EntityExistsError: Unable to create run template in workspace 'default': A run template with this name already exists.

I think this is more of a general issue, but I would remove the mention of workspaces here and add the name of the entity to the message.

3. I also realized one more thing about the run templates. I had some DockerSettings defined for my pipeline and before we could create the template, I had to create and push the build. When I look at the editor on the dashboard, I see the DockerSettings are not there, as the template is already tied to a build. I understand this is what's needed atm, but it might be nice to adjust things like builds or stacks of the templates in the future.

The issues that I mentioned are minor issues, feel free to merge if you want.

[schustmi]

When I tried to test this, I ran into some stuff that I was not expecting:

1. I forgot to switch to a remote stack and I got this error:

ValueError: Unable to create run template as there is no associated build.

While I understand where this is coming from, the new users might be a bit confused due to the message here. Maybe we can add something like: Make sure you have an active remote stack..

2. When I tried to use the same name for the template, I got the error:

EntityExistsError: Unable to create run template in workspace 'default': A run template with this name already exists.

I think this is more of a general issue, but I would remove the mention of workspaces here and add the name of the entity to the message.

3. I also realized one more thing about the run templates. I had some DockerSettings defined for my pipeline and before we could create the template, I had to create and push the build. When I look at the editor on the dashboard, I see the DockerSettings are not there, as the template is already tied to a build. I understand this is what's needed atm, but it might be nice to adjust things like builds or stacks of the templates in the future.

The issues that I mentioned are minor issues, feel free to merge if you want.

1. Some remote orchestrators are not supported, only containerized ones are. Which is why we need to check for a build here. I've updated the error message to try to make it a little clearer though
2. I added the template name to the error message. I think the workspace stuff I'd leave in there for now, until we either remove or rework them, as it's in 100 other places as well.
3. 100% agree, but this would be months of effort to get this working I think :P