ci: add auto-deploy.yml

[kagol]

Summary by CodeRabbit

• Chores
  • Introduced automated build and deployment of the documentation site to GitHub Pages, triggered by changes to documentation files or via manual action.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new GitHub Actions workflow named "Auto Deploy" has been introduced to automate the build and deployment of a Jekyll site to GitHub Pages. It triggers on specific pushes and manual invocations, runs build and deploy jobs, and manages concurrency to ensure only one deployment occurs at a time.

Changes

File(s)	Change Summary
.github/workflows/auto-deploy.yml	Added a workflow for automated build and deployment of a Jekyll site to GitHub Pages with concurrency control and two jobs: build and deploy.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Build Job
    participant Deploy Job
    participant GitHub Pages

    Developer->>GitHub Actions: Push to main (packages/docs/**) or manual trigger
    GitHub Actions->>Build Job: Start build job
    Build Job->>Build Job: Checkout repo, setup pnpm, install, build, Jekyll build
    Build Job->>GitHub Actions: Upload build artifact
    GitHub Actions->>Deploy Job: Start deploy job (after build success)
    Deploy Job->>GitHub Pages: Deploy artifact
    Deploy Job->>Developer: Expose deployed page URL

Loading

Poem

🐇
Hopped onto GitHub, a workflow anew,
Building with pnpm, and Jekyll too!
With every push, the docs take flight,
Deploying to Pages, sparkling bright.
One hop at a time, no race or rush—
Auto Deploy brings magic with each brush!

---

📜 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 0ea1a4c and e713398.

📒 Files selected for processing (1)

• .github/workflows/auto-deploy.yml (1 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch kagol/add-auto-deploy-workflow

---

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 auto-generate unit tests to generate unit tests for 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.