Skip to content

feat: add Codex package version enforcement#124

Merged
tzachbon merged 3 commits intomainfrom
codex/codex-version-ci
Mar 6, 2026
Merged

feat: add Codex package version enforcement#124
tzachbon merged 3 commits intomainfrom
codex/codex-version-ci

Conversation

@tzachbon
Copy link
Copy Markdown
Owner

@tzachbon tzachbon commented Mar 6, 2026

Summary

  • add a versioned Codex package manifest at platforms/codex/manifest.json
  • add PR CI that requires a semver bump when platforms/codex/** changes
  • document the Codex package version and add an upgrade prompt in the README

Testing

  • validated platforms/codex/manifest.json parses as JSON
  • reviewed the workflow logic for missing, unchanged, invalid, and downgraded versions
  • GitHub Actions not run locally

Summary by CodeRabbit

  • New Features

    • Adds manifest-based versioning for the Codex package and enforces version bumps on changes.
  • Documentation

    • Updated packaging, install, and upgrade instructions with explicit current version (4.8.4) and conditional reinstall guidance.
    • Added maintainer notes requiring manifest version updates when modifying Codex.
  • Chores

    • Introduced automated version-check validation to ensure PRs include valid, incremented package versions.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 6, 2026

Warning

Rate limit exceeded

@tzachbon has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 18 minutes and 36 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 414f474e-ba5b-4fd9-b1e5-01518a1e0a55

📥 Commits

Reviewing files that changed from the base of the PR and between a735378 and 835ecb7.

📒 Files selected for processing (2)
  • README.md
  • platforms/codex/README.md
📝 Walkthrough

Walkthrough

Adds a codex package manifest, documentation for a versioned codex package, and a new GitHub Actions workflow that validates manifest name and semantic version bumps on PRs modifying platforms/codex/.

Changes

Cohort / File(s) Summary
GitHub Actions Workflow
\.github/workflows/codex-version-check.yml
New workflow triggers on PRs affecting platforms/codex/**; checks out PR and base, detects codex changes, enforces manifest name "ralph-specum-codex", validates semver format, and requires PR version > base version when changes exist.
Codex Manifest
platforms/codex/manifest.json
New manifest added with "name": "ralph-specum-codex" and "version": "4.8.4".
Documentation
README.md, platforms/codex/README.md
Updated installation/upgrade guidance and maintainer notes to reference the manifest at platforms/codex/manifest.json, document current version (4.8.4), and describe the version-check workflow and required manifest bumps on codex changes.

Sequence Diagram

sequenceDiagram
    participant PR as "Pull Request"
    participant GitHub as "GitHub Actions"
    participant Git as "Git (repo)"
    participant Validator as "Version Validator / Script"
    participant Manifest as "platforms/codex/manifest.json"

    PR->>GitHub: Open/Update PR
    GitHub->>Git: Checkout PR ref and base
    Git->>GitHub: Provide workspace
    GitHub->>Git: Run git diff for platforms/codex/
    alt codex changes present
        GitHub->>Manifest: Read PR manifest.json
        Manifest-->>Validator: name, version (PR)
        GitHub->>Manifest: Read base manifest.json
        Manifest-->>Validator: version (base) or none
        Validator->>Validator: Validate name == "ralph-specum-codex"
        Validator->>Validator: Validate semver formats
        Validator->>Validator: Compare PR version > base version (if base exists)
        alt validations pass
            Validator-->>GitHub: Success (version check passed)
        else validation fails
            Validator-->>GitHub: Fail (error message)
        end
    else no codex changes
        GitHub-->>GitHub: Skip validation
    end
    GitHub->>PR: Post status / output message
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I nibble lines and count each patch,

A manifest now keeps versions matched,
The workflow hops to check the score,
Bumps and names I guard galore,
A tidy codex — hop, explore!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat: add Codex package version enforcement' directly describes the main change: introducing version enforcement for the Codex package through a new CI workflow and manifest.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/codex-version-ci

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.

@tzachbon tzachbon merged commit 76a66ba into main Mar 6, 2026
1 check passed
@tzachbon tzachbon deleted the codex/codex-version-ci branch March 6, 2026 16:09
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