feat: optional deployment of schemas

[Dexnjn]

This PR implements the optional deployment of the schemas folder.

Summary by CodeRabbit

• New Features

  • Introduced a new method for deploying schemas, enhancing the deployment process.
  • Added an option to the deployment method to conditionally include schema deployment.

• Bug Fixes

  • Improved logging to warn users if the schemas directory is not found during deployment.

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

The changes introduce a new method deploy_schemas in the WorkflowDeployer class within snakedeploy/deploy.py. This method is tasked with deploying the schemas directory from the source repository to the designated destination, including checks for the directory's existence. Additionally, the deploy method has been updated to accept a new parameter, schemas, which triggers the deploy_schemas method when set to True. The overall control flow of the deploy method has been modified accordingly.

Changes

File	Change Summary
snakedeploy/deploy.py	- Added method deploy_schemas(self) to deploy schemas directory. - Updated deploy(self, name: str) method signature to include schemas: bool = False.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WorkflowDeployer
    participant SourceRepo
    participant Destination

    User->>WorkflowDeployer: deploy(name, schemas=True)
    WorkflowDeployer->>WorkflowDeployer: check schemas directory
    alt schemas directory exists
        WorkflowDeployer->>SourceRepo: copy schemas to destination
        WorkflowDeployer->>Destination: deploy schemas
    else schemas directory does not exist
        WorkflowDeployer->>User: log warning (schemas not found)
    end

---

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.

CodeRabbit Configuration 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.

[cmeesters]

@Dexnjn & @johanneskoester are schemas a thing after Snakemake v8? With the plugin ecosystem for executors, there should be no need to deploy schemas any more. Yet, perhaps I am suffering from a misunderstanding. Then I would like to see an explanatory note added, too. ;-)