Skip to content

Conversation

@elibosley
Copy link
Member

@elibosley elibosley commented Nov 10, 2025

Summary by CodeRabbit

Release Notes

  • Chores
    • Implemented automated schema publishing workflow to Apollo Studio on updates to the main branch, ensuring schema documentation stays synchronized with API changes.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 10, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

A new GitHub Actions workflow is introduced to automatically publish the GraphQL schema to Apollo Studio whenever the generated schema file is modified on the main branch. The workflow installs Apollo Rover CLI and executes a publish command with authentication via GitHub Secrets.

Changes

Cohort / File(s) Summary
GitHub Actions Workflow
\.github/workflows/publish-schema\.yml
New workflow file that triggers on pushes to main branch when api/generated-schema.graphql changes; publishes schema to Apollo Studio using rover graph publish with APOLLO_KEY authentication.

Sequence Diagram

sequenceDiagram
    participant Repo as Repository<br/>(main branch)
    participant GHA as GitHub Actions
    participant Rover as Apollo Rover CLI
    participant Apollo as Apollo Studio

    Repo->>GHA: Push event<br/>(schema modified)
    activate GHA
    GHA->>GHA: Checkout repository
    GHA->>Rover: Install Rover CLI
    activate Rover
    Rover-->>GHA: CLI ready
    deactivate Rover
    GHA->>Apollo: rover graph publish<br/>(Unraid-API@current)
    activate Apollo
    Apollo-->>GHA: Schema published
    deactivate Apollo
    deactivate GHA
Loading

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify the trigger condition correctly targets api/generated-schema.graphql modifications
  • Confirm APOLLO_KEY secret is properly configured in GitHub repository settings
  • Validate rover command syntax and project identifier (Unraid-API@current) accuracy

Poem

🐰 A schema workflow hops into place,
Rover runs with CI/CD grace—
When Apollo calls, the graph will rise,
Publishing truth before our eyes! ✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/schema-publishing

📜 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 d18eaf2 and c2a7a9c.

📒 Files selected for processing (1)
  • .github/workflows/publish-schema.yml (1 hunks)

Comment @coderabbitai help to get the list of available commands and usage tips.

@elibosley elibosley merged commit 7e13202 into main Nov 10, 2025
7 of 8 checks passed
@elibosley elibosley deleted the feat/schema-publishing branch November 10, 2025 17:03
@codecov
Copy link

codecov bot commented Nov 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.69%. Comparing base (d18eaf2) to head (c2a7a9c).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1772   +/-   ##
=======================================
  Coverage   52.69%   52.69%           
=======================================
  Files         865      865           
  Lines       49346    49346           
  Branches     4952     4952           
=======================================
  Hits        26003    26003           
  Misses      23270    23270           
  Partials       73       73           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Contributor

This plugin has been deployed to Cloudflare R2 and is available for testing.
Download it at this URL:

https://preview.dl.unraid.net/unraid-api/tag/PR1772/dynamix.unraid.net.plg

elibosley pushed a commit that referenced this pull request Nov 17, 2025
🤖 I have created a release *beep* *boop*
---


## [4.26.0](v4.25.3...v4.26.0)
(2025-11-17)


### Features

* add cpu power query & subscription
([#1745](#1745))
([d7aca81](d7aca81))
* add schema publishing to apollo studio
([#1772](#1772))
([7e13202](7e13202))
* add workflow_dispatch trigger to schema publishing workflow
([818e7ce](818e7ce))
* apollo studio readme link
([c4cd0c6](c4cd0c6))
* **cli:** make `unraid-api plugins remove` scriptable
([#1774](#1774))
([64eb9ce](64eb9ce))
* use persisted theme css to fix flashes on header
([#1784](#1784))
([854b403](854b403))


### Bug Fixes

* **api:** decode html entities before parsing notifications
([#1768](#1768))
([42406e7](42406e7))
* **connect:** disable api plugin if unraid plugin is absent
([#1773](#1773))
([c264a18](c264a18))
* detection of flash backup activation state
([#1769](#1769))
([d18eaf2](d18eaf2))
* re-add missing header gradient styles
([#1787](#1787))
([f8a6785](f8a6785))
* respect OS safe mode in plugin loader
([#1775](#1775))
([92af3b6](92af3b6))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants