Skip to content

chore: Update skill and operator package version#232

Merged
zeljkoX merged 1 commit into
mainfrom
release-dashboard-api-improvements
May 18, 2026
Merged

chore: Update skill and operator package version#232
zeljkoX merged 1 commit into
mainfrom
release-dashboard-api-improvements

Conversation

@zeljkoX
Copy link
Copy Markdown
Collaborator

@zeljkoX zeljkoX commented May 18, 2026

This PR updates operator package/readme versions and skill for publishing packages.

Summary by CodeRabbit

  • Documentation

    • Expanded Guardian Operator Client documentation with new sections covering account snapshots with state examples, cross-account delta feeds with pagination and filtering, and in-flight proposal feeds with field documentation.
  • Chores

    • Guardian Operator Client version updated to 0.14.6.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

Walkthrough

The guardian-operator-client package version is bumped from 0.14.3 to 0.14.6, and it is formally integrated into the release automation workflow. New endpoint documentation covers account snapshots and cross-account feed pagination with practical examples.

Changes

Guardian Operator Client Release and Documentation

Layer / File(s) Summary
Version Bump and Release Task Integration
packages/guardian-operator-client/package.json, .agents/skills/release-guardian-sdk-packages/SKILL.md
Version updated to 0.14.6. Release automation updated to include the operator-client in source-of-truth inputs, TypeScript lockfile refresh, validation commands (npm test, npm run build), publish dry-run sequence, and final publish order.
API Documentation for New Endpoints
packages/guardian-operator-client/README.md
Decoded account snapshot endpoint documented with canonicalized state explanation and vault asset iteration example. Cross-account delta feed and in-flight proposal feed endpoints documented with pagination behavior and query filter serialization examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • tirumerla

Poem

🐰 A version bumps with grace so fine,
Release tasks align in perfect line,
New docs bloom like clover in spring,
The operator client spreads its wing! 🌱

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes: updating the operator package version and updating the skill documentation for release tasks.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release-dashboard-api-improvements

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.agents/skills/release-guardian-sdk-packages/SKILL.md:
- Around line 98-103: The command blocks in SKILL.md use sequential relative cd
commands which break if pasted together; update each package installation line
(the bash snippets under SKILL.md around the shown blocks) so each step is
execution-safe by running the cd and npm install in a subshell or otherwise
resetting to repo root (e.g., use (cd packages/guardian-client && npm install
--package-lock-only) style for the lines that currently contain "cd packages/...
&& npm install --package-lock-only"), and apply the same change to the other
affected blocks referenced (around lines 118-127 and 138-143) so every command
can be run independently from any current directory.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9ad9b0be-3e44-4179-aa75-899611a073a6

📥 Commits

Reviewing files that changed from the base of the PR and between 4333dcd and d278421.

⛔ Files ignored due to path filters (1)
  • packages/guardian-operator-client/package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • .agents/skills/release-guardian-sdk-packages/SKILL.md
  • packages/guardian-operator-client/README.md
  • packages/guardian-operator-client/package.json

Comment on lines 98 to 103
```bash
cd packages/guardian-client && npm install --package-lock-only
cd packages/guardian-evm-client && npm install --package-lock-only
cd packages/miden-multisig-client && npm install --package-lock-only
cd packages/guardian-operator-client && npm install --package-lock-only
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Make command blocks execution-safe from any current directory.

Line 99 onward uses sequential relative cd commands; after the first cd, later paths can break when copy-pasted in one shell. Wrap each step in a subshell (or reset to repo root) so every command is independently runnable.

Suggested patch
-cd packages/guardian-client && npm install --package-lock-only
-cd packages/guardian-evm-client && npm install --package-lock-only
-cd packages/miden-multisig-client && npm install --package-lock-only
-cd packages/guardian-operator-client && npm install --package-lock-only
+(cd packages/guardian-client && npm install --package-lock-only)
+(cd packages/guardian-evm-client && npm install --package-lock-only)
+(cd packages/miden-multisig-client && npm install --package-lock-only)
+(cd packages/guardian-operator-client && npm install --package-lock-only)
-cd packages/guardian-client && npm test
-cd packages/guardian-client && npm run build
-cd packages/guardian-evm-client && npm test
-cd packages/guardian-evm-client && npm run build
-cd packages/miden-multisig-client && npm test
-cd packages/miden-multisig-client && npm run build
-cd packages/guardian-operator-client && npm test
-cd packages/guardian-operator-client && npm run build
+(cd packages/guardian-client && npm test)
+(cd packages/guardian-client && npm run build)
+(cd packages/guardian-evm-client && npm test)
+(cd packages/guardian-evm-client && npm run build)
+(cd packages/miden-multisig-client && npm test)
+(cd packages/miden-multisig-client && npm run build)
+(cd packages/guardian-operator-client && npm test)
+(cd packages/guardian-operator-client && npm run build)
-cd packages/guardian-client && npm publish --access public --dry-run
-cd packages/guardian-evm-client && npm publish --access public --dry-run
-cd packages/miden-multisig-client && npm publish --access public --dry-run
-cd packages/guardian-operator-client && npm publish --access public --dry-run
+(cd packages/guardian-client && npm publish --access public --dry-run)
+(cd packages/guardian-evm-client && npm publish --access public --dry-run)
+(cd packages/miden-multisig-client && npm publish --access public --dry-run)
+(cd packages/guardian-operator-client && npm publish --access public --dry-run)

Also applies to: 118-127, 138-143

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/release-guardian-sdk-packages/SKILL.md around lines 98 - 103,
The command blocks in SKILL.md use sequential relative cd commands which break
if pasted together; update each package installation line (the bash snippets
under SKILL.md around the shown blocks) so each step is execution-safe by
running the cd and npm install in a subshell or otherwise resetting to repo root
(e.g., use (cd packages/guardian-client && npm install --package-lock-only)
style for the lines that currently contain "cd packages/... && npm install
--package-lock-only"), and apply the same change to the other affected blocks
referenced (around lines 118-127 and 138-143) so every command can be run
independently from any current directory.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the @openzeppelin/guardian-operator-client package version from 0.14.3 to 0.14.6 (with matching lockfile bump), adds README documentation for several new client methods, and registers the operator client in the release skill checklist so future coordinated releases include it.

Changes:

  • Bump guardian-operator-client version to 0.14.6 in package.json and package-lock.json.
  • Document getAccountSnapshot, listGlobalDeltas, and listGlobalProposals in the package README.
  • Add the operator client to the release-skill source-of-truth list, version bump list, lockfile refresh, test/build, dry-run, and publish-order sections.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.

File Description
packages/guardian-operator-client/README.md Adds usage examples for three new client methods.
packages/guardian-operator-client/package.json Bumps version to 0.14.6.
packages/guardian-operator-client/package-lock.json Mirrors version bump in lockfile.
.agents/skills/release-guardian-sdk-packages/SKILL.md Registers operator client across all release-skill steps.
Files not reviewed (1)
  • packages/guardian-operator-client/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.18%. Comparing base (4333dcd) to head (d278421).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #232   +/-   ##
=======================================
  Coverage   73.18%   73.18%           
=======================================
  Files         122      122           
  Lines       21565    21565           
=======================================
  Hits        15782    15782           
  Misses       5783     5783           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4333dcd...d278421. Read the comment docs.

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

@zeljkoX zeljkoX merged commit aba731f into main May 18, 2026
20 checks passed
@zeljkoX zeljkoX deleted the release-dashboard-api-improvements branch May 18, 2026 13:33
@github-actions github-actions Bot locked and limited conversation to collaborators May 18, 2026
@zeljkoX zeljkoX restored the release-dashboard-api-improvements branch May 28, 2026 11:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants