feat: add run-one-check workflow for the new CLI

[UlisesGascon]

Related #216

Summary by CodeRabbit

• New Features
  • Introduced a new workflow command to run a specific compliance check on stored data.
  • Added input validation for the new command using a dedicated schema.
  • Enhanced the existing compliance scorecard workflow with optional project selection and input validation.
  • Workflow metadata now includes detailed input schema information for better transparency.
• Bug Fixes
  • Improved error handling and validation feedback for workflow commands.

[coderabbitai]

"""

Walkthrough

A new workflow command run-one-check has been added, allowing execution of a specific compliance check with input validated by a new JSON schema. Existing workflow metadata now includes associated schemas, and validation utilities and schema exports are updated. A new function for running individual compliance checks is introduced.

Changes

File(s)	Change Summary
src/cli/workflows.js	Added run-one-check workflow command, integrated schema validation, updated workflow metadata to include schema.
src/schemas/execute-one-check.json	New schema for validating input with required check_name property.
src/schemas/execute-optional-project.json	New schema for optional project_id and required check_name property.
src/schemas/index.js	Imported new schemas, added validateExecuteOneCheck, updated exports with new schemas and validation function.
src/workflows/index.js	Added and exported runOneComplianceCheck function for executing a single compliance check.

Sequence Diagram(s)

sequenceDiagram
    participant CLI
    participant Workflows
    participant Schemas
    participant Checks

    CLI->>Workflows: runOneComplianceCheck(knex, data)
    Workflows->>Schemas: validateExecuteOneCheck(data)
    Schemas-->>Workflows: validation result
    Workflows->>Checks: get check function by check_name
    alt Check exists
        Workflows->>Checks: execute check(knex)
        Checks-->>Workflows: check result
        Workflows-->>CLI: success message
    else Check not found
        Workflows-->>CLI: error (check not found)
    end

Loading

Possibly related PRs

• OpenPathfinder/visionBoard#249: Updates workflow metadata structure and schema exposure, overlapping with changes to workflow command definitions and schema integration.

Poem

In the warren of code, a new check hops in,
With schemas to guide where the data begin.
One check at a time, compliance is tight,
Validations ensure that all is right.
🐇 The workflows now sparkle, neat and new—
A bunny’s proud of what this team can do!
"""

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 126f3e0 and b61803d.

⛔ Files ignored due to path filters (1)

• __tests__/cli/__snapshots__/workflows.test.js.snap is excluded by !**/*.snap

📒 Files selected for processing (5)

• src/cli/workflows.js (3 hunks)
• src/schemas/execute-one-check.json (1 hunks)
• src/schemas/execute-optional-project.json (1 hunks)
• src/schemas/index.js (3 hunks)
• src/workflows/index.js (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (5)

• src/schemas/execute-one-check.json
• src/schemas/index.js
• src/workflows/index.js
• src/schemas/execute-optional-project.json
• src/cli/workflows.js

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.