Add CI for Pull Requests

[anatawa12]

Summary by CodeRabbit

• New Features
  • Introduced an automated workflow to convert Markdown documents into PDF format, enhancing the documentation process.
  • PDF artifacts will be generated automatically upon pull requests and pushes that involve Markdown files, ensuring up-to-date documentation.

[coderabbitai]

Walkthrough

This change introduces a new GitHub Actions workflow that automates the conversion of Markdown files in the docs directory into PDF format. Triggered by pull requests and pushes, the workflow cleans the output directory, converts Markdown to PDF, and uploads the resulting files as artifacts. This enhancement streamlines documentation updates, ensuring that changes are promptly reflected in the generated PDFs.

Changes

File Path	Change Summary
.github/workflows/markdownToPdfArtifacts.yml	New workflow added for automated Markdown to PDF conversion.

Sequence Diagram(s)

sequenceDiagram
    participant Git as GitHub
    participant Workflow as CI Workflow
    participant Action as Markdown to PDF Action
    participant Artifacts as Artifacts Storage

    Git->>Workflow: Trigger on PR/Push
    Workflow->>Git: Checkout code
    Workflow->>Workflow: Clean up PDF directory
    Workflow->>Action: Convert Markdown to PDF
    Action->>Artifacts: Upload generated PDFs

Loading

Poem

🐰 In the land of docs so wide,
A new workflow takes a ride!
Markdown to PDF, oh what a sight,
Artifacts ready, all done right!
Hopping through changes, we cheer with glee,
Documentation flows like a stream, carefree! 🌼

---

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

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4b47ac7 and c4b626a.

Files selected for processing (1)

• .github/workflows/markdownToPdfArtifacts.yml (1 hunks)

Additional comments not posted (6)

.github/workflows/markdownToPdfArtifacts.yml (6)

1-10: LGTM! The workflow name and triggers are appropriate.

The workflow is correctly set up to trigger on pull requests and pushes to the specified paths.

---

12-15: LGTM! The job configuration is appropriate.

The job is correctly set up with a descriptive name and runs on ubuntu-latest.

---

17-18: LGTM! The Checkout step is correctly configured.

The step uses actions/checkout@v4 to check out the repository.

---

20-21: LGTM! The Remove old PDFs step is correctly configured.

The step removes the pdfs directory to clean up old PDFs.

---

23-28: LGTM! The Convert to PDF step is correctly configured.

The step uses baileyjm02/markdown-to-pdf@v1 with appropriate inputs for the conversion.

---

30-33: LGTM! The Upload as Artifact step is correctly configured.

The step uses actions/upload-artifact@v4 to upload the pdfs directory as an artifact.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c4b626a and 491ee5c.

Files selected for processing (1)

• .github/workflows/markdownToPdfArtifacts.yml (1 hunks)

Files skipped from review due to trivial changes (1)

• .github/workflows/markdownToPdfArtifacts.yml

[yuya-0928]

Artifactが生成されていることを確認&中身のPDFも問題なさそうなことを確認しました！
masterでPDF作るワークフローとも衝突しなさそうなので、問題なさそう