Skip to content

Fix docbuild action #495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
d-chambers merged 2 commits into from
Mar 8, 2025
Merged

Fix docbuild action #495

d-chambers merged 2 commits into from
Mar 8, 2025

Conversation

@d-chambers
Copy link
Contributor

@d-chambers d-chambers commented Mar 8, 2025 •
edited by coderabbitai bot
Loading

Description

Part 2 to #494. Trying to add explicit quarto project render to custom build doc action. Apparently the build master docs action triggered on the quarto publish command, but since build stable docs doesn't have this the project is not getting rendered.

Checklist

I have (if applicable):

  • referenced the GitHub issue this PR closes.
  • documented the new feature with docstrings or appropriate doc page.
  • included a test. See testing guidelines.
  • your name has been added to the contributors page (docs/contributors.md).
  • added the "ready_for_review" tag once the PR is ready to be reviewed.

Summary by CodeRabbit

  • New Features
    • Enhanced the documentation build process with an additional step for rendering improved content.
  • Chores
    • Updated and upgraded key steps in the documentation deployment workflow to boost performance and reliability.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 8, 2025 •
edited
Loading

Walkthrough

The changes update two GitHub Actions configurations. One update introduces a new step to render a Quarto project via a bash command in the documentation build workflow. The other update upgrades multiple GitHub Actions versions used for configuring pages, uploading artifacts, deploying pages, and releasing documentation. These adjustments affect the build and deploy processes for documentation without altering the core functionality.

Changes

File Change Summary
.github/actions/build-docs/action.yml Added a new step named "build quarto project" that executes quarto render docs using a bash shell, following the existing API docs rendering step.
.github/workflows/build_deploy_stable_docs.yaml Upgraded GitHub Actions versions: actions/configure-pages from v2 to v5, actions/upload-pages-artifact from v1 to v3, actions/deploy-pages from v1 to v3, and softprops/action-gh-release from v1 to v2.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Workflow as GitHub Workflow
    participant API as API Docs Step
    participant Quarto as Quarto Project Step
    participant Deploy as Deployment Step

    Dev->>Workflow: Push commit to repo
    Workflow->>API: Execute API documentation script
    API-->>Workflow: API docs rendered
    Workflow->>Quarto: Run "quarto render docs"
    Quarto-->>Workflow: Quarto docs rendered
    Workflow->>Deploy: Deploy updated documentation (using upgraded actions)
    Deploy-->>Workflow: Deployment complete
Loading

Suggested labels

documentation

Poem

I'm a rabbit, hopping on code's bright track,
Jumping into steps that never look back.
With Quarto and actions all updated anew,
I celebrate changes with a joyful hop or two.
In the world of docs, I'm light on my feet,
Spreading cheer with each commit so sweet.

📜 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 f4f382e and 8ce3491.

📒 Files selected for processing (2)
  • .github/actions/build-docs/action.yml (1 hunks)
  • .github/workflows/build_deploy_stable_docs.yaml (1 hunks)
🔇 Additional comments (5)
.github/actions/build-docs/action.yml (1)

22-27: New Quarto Build Step Added
The newly added step "build quarto project" correctly invokes quarto render docs using a Bash shell. Please verify that the docs directory is the intended target for your Quarto project and that it exists in the repository structure.

.github/workflows/build_deploy_stable_docs.yaml (4)

44-46: Updated Configure Pages Action Version
The "Setup Pages" step has been updated to use actions/configure-pages@v5. This upgrade should offer improved functionality and security. Please confirm that no breaking changes affect your workflow configuration.

47-51: Updated Artifact Upload Action
The artifact upload step now leverages actions/upload-pages-artifact@v3, which is a welcome update. Make sure that the specified path (docs/_site) correctly reflects the directory containing your built documentation.

52-55: Updated Deployment Action Version
The deployment step has been revised to use actions/deploy-pages@v3. This update should enhance the deployment process. Please verify that the resulting page URL extracted via ${{ steps.deployment.outputs.page_url }} remains correct.

59-64: Updated Release Documentation Action
The step for uploading release documentation now uses softprops/action-gh-release@v2. While this version upgrade is positive, ensure that you have reviewed the changelog for any configuration adjustments that might be required.

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
🪧 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 generate docstrings to generate docstrings 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.

@d-chambers d-chambers merged commit fce1988 into master Mar 8, 2025
2 checks passed
@d-chambers d-chambers mentioned this pull request Mar 10, 2025
Merged
5 tasks
@d-chambers d-chambers deleted the fix_docbuild_action branch September 19, 2025 11:35
@coderabbitai coderabbitai bot mentioned this pull request Sep 20, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@d-chambers