Skip to content

Refresh workflow docs and project skills#4

Merged
chrisjcthomas merged 1 commit into
mainfrom
codex/workflow-metadata-refresh
Mar 22, 2026
Merged

Refresh workflow docs and project skills#4
chrisjcthomas merged 1 commit into
mainfrom
codex/workflow-metadata-refresh

Conversation

@chrisjcthomas

@chrisjcthomas chrisjcthomas commented Mar 22, 2026

Copy link
Copy Markdown
Owner

Summary

  • Problem:
  • Goal:
  • Acceptance criteria:

Validation

  • Commands run:
    • npm run validate
    • npm run smoke:packaged
    • npm run test:visual
  • Artifact tested:
    • npm run dev
    • release/win-unpacked/WSA Manager.exe
    • release/WSA.Manager.Setup.<version>.exe

Codex review

  • @codex review requested on this PR, or automatic reviews are enabled
  • Extra review focus was added when needed

UI evidence

  • Visual reference used:
  • Target window sizes:
  • Baselines changed:
    • No
    • Yes
  • Screenshots:

Notes

  • Risks:
  • Follow-ups:

Open with Devin

Summary by CodeRabbit

  • Documentation
    • Added new operational procedures for PR review, release validation, UI smoke testing, and visual baseline debugging.
    • Updated existing workflow guides and consolidated active documentation references.
    • Reorganized project docs with archive markers for historical materials.
    • Enhanced PR template to require review thread resolution before merging.
    • Improved developer guidance on concurrent packaging safety and visual baseline handling.

@coderabbitai

coderabbitai Bot commented Mar 22, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This PR establishes comprehensive workflow documentation for WSA Manager, including new Codex review operations and visual baseline debugging procedures, updated artifact validation and UI testing workflows, restructured documentation with archive distinctions, and reinforced PR merge requirements.

Changes

Cohort / File(s) Summary
New Codex Skills
.codex/skills/codex-pr-review-ops/SKILL.md, .codex/skills/visual-baseline-debug/SKILL.md
Added two new skill documents: PR review ops checklist covering branch naming, description matching, Codex review guidance, and merge-readiness validation; visual baseline debugging procedure for triaging screenshot mismatches with focus on determinism and targeted corrections.
Updated Release & UI Workflows
.codex/skills/release-check/SKILL.md, .codex/skills/ui-smoke/SKILL.md, .codex/skills/wsa-readiness-debug/SKILL.md
Updated release-check to serialize packaging steps and validate GitHub asset naming contracts; updated ui-smoke to use canonical unpacked artifact and add visual baseline comparisons; restructured wsa-readiness-debug with diagnostic-first triage and branch-specific inspection sequences.
Root Workflow Documentation
AGENTS.md, README.md, .github/pull_request_template.md
Added active source-of-truth documentation set definition, release/packaging concurrency constraints, visual baseline failure diagnosis guidance, merge-readiness checklist, and review thread resolution requirement in PR template.
Documentation Index & Archive Markers
docs/README.md, docs/archive/*
Added docs index clarifying active vs. archived workflow documents; added "archived note" headers to historical guides and scripts (WSA_Cleanup_Guide.md, wsa-electron-roadmap.md, wsa_cleanup_apkmirror_cinexplore.ps1).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 Whiskers twitch with delight,
Workflows documented, oh what a sight!
From baselines to reviews, each step made clear,
The repo blooms brighter throughout the year!
–a satisfied rabbit 🌿✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description contains only the empty template scaffold with no filled-in content for Problem, Goal, Acceptance criteria, validation results, UI evidence, or notes, making it largely incomplete. Fill in the Summary section with the Problem, Goal, and Acceptance criteria for this documentation refresh, and indicate which validation commands were executed and which artifacts were tested.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Refresh workflow docs and project skills' accurately summarizes the main changes, which involve updating documentation files and skill definitions throughout the repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 codex/workflow-metadata-refresh

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

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

@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refines and formalizes the development, testing, and review workflows for the WSA Manager project. It introduces new operational skills, updates existing ones with more precise steps, and clarifies the documentation structure to ensure that current and future contributors have a clear, consistent, and up-to-date source of truth for project processes and guidelines.

Highlights

  • New Operational Skills: Introduced two new operational skills: codex-pr-review-ops to formalize the PR review and merge-readiness workflow, and visual-baseline-debug to guide the debugging of UI screenshot mismatches.
  • Enhanced Workflow Documentation: Updated existing skills (release-check, ui-smoke, wsa-readiness-debug) with more detailed, robust, and explicit steps for testing, building, and debugging, emphasizing serial execution of packaged commands.
  • Formalized Documentation Structure: Established a clear documentation hierarchy by creating a central docs/README.md index and moving older, less relevant documents into a new docs/archive/ directory, marking them as historical references.
  • Updated Repository Guidelines: Revised core repository documentation (AGENTS.md, README.md) to reflect the new documentation structure, explicitly list active workflow documents, clarify valid app targets, and add new rules for visual baseline debugging and PR merge readiness.
  • Improved Pull Request Template: Modified the pull request template to include a mandatory checklist item ensuring that all review threads are resolved before a PR can be merged, reinforcing review quality.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request provides a comprehensive update to the project's workflow documentation. It clarifies development processes, organizes documents into 'active' and 'archived' categories, and adds new 'skills' for automated agents. The changes are well-structured and significantly improve the clarity of the project's documentation. I have a couple of suggestions to further improve consistency and long-term maintainability.

Comment thread .codex/skills/release-check/SKILL.md
Comment thread AGENTS.md

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 3 additional findings.

Open in Devin Review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Breezy!

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@chrisjcthomas

Copy link
Copy Markdown
Owner Author

@codex review

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.codex/skills/release-check/SKILL.md:
- Around line 17-21: The README.md and SKILL.md require a release asset named
`WSA.Manager.portable.<tag>.zip` but the build config in package.json only
defines electron-builder targets `nsis` and `dir`, so the build cannot produce
that portable zip; fix by either adding a portable/zip target to
electron-builder (e.g., include the `portable` or `zip` target in the
`build.targets` section of package.json so `WSA.Manager.portable.<tag>.zip` is
emitted) or by updating README.md and SKILL.md to remove or correct the
`WSA.Manager.portable.<tag>.zip` requirement and align release validation with
the actual `nsis`/`dir` artifacts, and ensure the release-check step references
the updated artifact names.
- Line 15: The SKILL.md documents that
release/WSA.Manager.Setup.<version>.exe.blockmap must be produced but
scripts/check-release-layout.mjs currently doesn't validate it; update the
release layout validator (e.g., the function that enumerates/validates artifacts
in scripts/check-release-layout.mjs, likely named validateReleaseLayout or
similar) to explicitly assert the presence of a file matching the glob/re
pattern release/WSA.Manager.Setup.*.exe.blockmap (use fs or a glob to find a
matching filename), and fail/report a clear error if no such blockmap is found
so the script enforces the SKILL.md requirement.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cb21e5a0-ab48-4f49-a7cf-ad77c359d008

📥 Commits

Reviewing files that changed from the base of the PR and between 846b4ea and c8a8d20.

📒 Files selected for processing (12)
  • .codex/skills/codex-pr-review-ops/SKILL.md
  • .codex/skills/release-check/SKILL.md
  • .codex/skills/ui-smoke/SKILL.md
  • .codex/skills/visual-baseline-debug/SKILL.md
  • .codex/skills/wsa-readiness-debug/SKILL.md
  • .github/pull_request_template.md
  • AGENTS.md
  • README.md
  • docs/README.md
  • docs/archive/WSA_Cleanup_Guide.md
  • docs/archive/wsa-electron-roadmap.md
  • docs/archive/wsa_cleanup_apkmirror_cinexplore.ps1

Comment thread .codex/skills/release-check/SKILL.md
Comment thread .codex/skills/release-check/SKILL.md
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Delightful!

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@chrisjcthomas chrisjcthomas merged commit a670f7a into main Mar 22, 2026
5 checks passed
@chrisjcthomas chrisjcthomas deleted the codex/workflow-metadata-refresh branch March 22, 2026 01:44
@coderabbitai coderabbitai Bot mentioned this pull request May 20, 2026
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.

1 participant