docs: programmatic deployment blogpost

[michael-0acf4]

Blogpost to help discover programmatic deployment additions.

Migration notes

...

• The change comes with new or modified tests
• Hard-to-understand functions have explanatory comments
• End-user documentation is updated to reflect the change

Summary by CodeRabbit

• New Features

  • Introduced programmatic deployment feature for deploying typegraphs within the Metatype ecosystem using TypeScript/Python SDKs.
  • Added new configuration options and deployment functions to enhance automation and flexibility in deployment processes.

• Documentation

  • Added a new blog post detailing the programmatic deployment feature and its usage.

[linear]

MET-565 (docs) programmatic deployment (v0.4.x)

[michael-0acf4]

@coderabbitai review

[coderabbitai]

Walkthrough

The new programmatic deployment feature (v0.4.x) for the Metatype ecosystem allows typegraphs to be deployed using TypeScript and Python SDKs. This enhancement introduces automation capabilities, enabling tools to perform deployment operations more flexibly and programmatically. Key additions include configuration parameters and deployment functions, streamlining the deployment process.

Changes

Files/Paths	Change Summary
website/blog/2024-05-09-programmatic-deployment/index.mdx	Introduced the programmatic deployment feature, added imports for SDKTabs and TabItem.
TypeScript SDK files	Added config_params, artifacts_config, config, artifactsConfig declarations, and functions getTypegraphs, getConfig, deployAll, undeployAll.
Python SDK files	Added config_params, artifacts_config, and config declarations for deployment configuration.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant SDK
    participant DeploymentService
    User->>SDK: Call deployAll()
    SDK->>DeploymentService: Send deployment configurations
    DeploymentService->>SDK: Acknowledge receipt
    SDK->>User: Return deployment status

Loading

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 4

[zifeo]

Can you add how to upgrade to the 0.4.x series as a last step in the article?

[zifeo]

👏