Skip to content

Conversation

@emnul
Copy link
Contributor

@emnul emnul commented Nov 3, 2025

This PR updates community health files, dev container tooling, tooling docs and tests to refer to compact 0.26.0.

Summary by CodeRabbit

  • New Features

    • Added OpenZeppelin Compact Simulator support.
  • Chores

    • Updated Compact toolchain to version 0.26.0 across documentation, development environment, and related resources.

@emnul emnul requested a review from a team as a code owner November 3, 2025 23:24
@coderabbitai
Copy link

coderabbitai bot commented Nov 3, 2025

Walkthrough

Version string updated from 0.25.0 to 0.26.0 across devcontainer configuration, documentation files, source code examples, test files, and changelog entries. All changes are string replacements with no functional logic modifications.

Changes

Cohort / File(s) Change Summary
Development Container Configuration
.devcontainer/Dockerfile, .devcontainer/devcontainer.json
Updated COMPACT_TOOLCHAIN_VERSION ARG and postCreateCommand version reference from 0.25.0 to 0.26.0
GitHub Templates & Issue Configuration
.github/ISSUE_TEMPLATE/01_bug_report.yml
Updated bug report dropdown default version from 0.25.0 to 0.26.0
Project Documentation
README.md, docs/modules/ROOT/pages/index.adoc
Updated version strings in badge URLs, displayed version references, and code snippets from 0.25.0 to 0.26.0
Changelog
CHANGELOG.md
Added Unreleased entry for OpenZeppelin Compact Simulator and package ownership change
Source Code Documentation
packages/compact/src/Builder.ts, packages/compact/src/Compiler.ts, packages/compact/src/runBuilder.ts, packages/compact/src/runCompiler.ts
Updated version strings in inline documentation, code examples, and log output from 0.25.0 to 0.26.0
Test Files
packages/compact/test/Compiler.test.ts, packages/compact/test/runCompiler.test.ts
Updated hard-coded version strings and test expectations from 0.25.0 to 0.26.0; minor formatting adjustments in mock implementations

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

This change represents a highly homogeneous version bump applied uniformly across the codebase. All modifications are straightforward string replacements with no logic changes, structural modifications, or behavioral impacts. The repetitive nature and lack of complexity make this a minimal review effort.

Poem

🐰 From 0.25 to 0.26 we hop,\n
A version bump that won't stop,\n
Through configs, docs, and tests we sprint,\n
Each string replaced without a hint,\n
Of logic change—just version cheer! ✨

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the primary changes: updating Compact tooling, tests, CHANGELOG, and README to version 0.26.0, matching the changeset scope.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-readme

📜 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 0c3d88d and 4db3053.

📒 Files selected for processing (12)
  • .devcontainer/Dockerfile (1 hunks)
  • .devcontainer/devcontainer.json (1 hunks)
  • .github/ISSUE_TEMPLATE/01_bug_report.yml (1 hunks)
  • CHANGELOG.md (1 hunks)
  • README.md (2 hunks)
  • docs/modules/ROOT/pages/index.adoc (1 hunks)
  • packages/compact/src/Builder.ts (2 hunks)
  • packages/compact/src/Compiler.ts (11 hunks)
  • packages/compact/src/runBuilder.ts (1 hunks)
  • packages/compact/src/runCompiler.ts (3 hunks)
  • packages/compact/test/Compiler.test.ts (19 hunks)
  • packages/compact/test/runCompiler.test.ts (6 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
packages/compact/test/Compiler.test.ts (1)
packages/compact/src/Compiler.ts (2)
  • UIService (303-404)
  • CompactCompiler (435-713)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Run Test Suite
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (12)
.devcontainer/Dockerfile (1)

6-6: LGTM! Toolchain version updated correctly.

The dev container toolchain version has been properly updated to align with the repository-wide version bump to 0.26.0.

packages/compact/src/Compiler.ts (1)

42-42: LGTM! Documentation examples updated consistently.

All version references in JSDoc comments and usage examples have been properly updated from 0.25.0 to 0.26.0. These changes maintain consistency across the documentation without affecting functionality.

Also applies to: 103-103, 125-125, 218-218, 250-250, 299-299, 336-338, 422-422, 455-466, 503-507

.github/ISSUE_TEMPLATE/01_bug_report.yml (1)

96-96: LGTM! Bug report template updated.

The default version in the bug report template has been correctly updated to 0.26.0, ensuring users report issues with the current version.

packages/compact/src/runBuilder.ts (1)

22-22: LGTM! Example output updated.

The expected output example in the JSDoc has been updated to reflect the correct version string that users will see when running the builder.

docs/modules/ROOT/pages/index.adoc (1)

23-24: LGTM! Documentation version updated.

The installation documentation now correctly shows the expected version output (0.26.0) that users will see when verifying their Compact installation.

packages/compact/src/Builder.ts (1)

32-34: LGTM! Example outputs updated.

The JSDoc example outputs showing compilation results have been correctly updated to display version 0.26.0, maintaining consistency with the actual compiler output.

Also applies to: 44-44

packages/compact/src/runCompiler.ts (1)

43-43: LGTM! Usage documentation updated.

The command-line usage examples and help text have been correctly updated to reference version 0.26.0, helping users understand how to specify the current toolchain version.

Also applies to: 182-182, 208-208

README.md (1)

1-1: LGTM! README version references updated.

The README has been properly updated with the new version:

  • The Compact Compiler badge now displays and links to version 0.26.0
  • The installation verification example shows the correct expected output

These changes ensure users see accurate version information when visiting the repository.

Also applies to: 23-24

CHANGELOG.md (1)

10-19: LGTM! CHANGELOG properly updated.

The new unreleased entries are well-documented, and the version history is maintained correctly. The addition of the OpenZeppelin Compact Simulator and package restructuring note provides clear context for the changes.

packages/compact/test/Compiler.test.ts (1)

107-877: LGTM! Test expectations consistently updated to version 0.26.0.

All test cases have been properly updated to reflect the new toolchain version. The version strings in mock outputs, expected command arguments, and assertions are consistent throughout. The minor formatting adjustments in mockImplementation functions (lines 204, 336) are stylistic and don't affect test behavior.

.devcontainer/devcontainer.json (1)

6-6: LGTM! Devcontainer toolchain version updated correctly.

The postCreateCommand now installs version 0.26.0, ensuring the development environment uses the correct toolchain version aligned with the rest of the PR.

packages/compact/test/runCompiler.test.ts (1)

53-458: LGTM! CLI integration tests updated to version 0.26.0.

The usage help examples and test scenarios have been properly updated to reference the new version. The formatting adjustment in mockImplementation (line 53) is stylistic. All integration test cases correctly validate the new version string handling.


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

Copy link
Member

@0xisk 0xisk left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you @emnul

@emnul emnul merged commit a43fbb7 into main Nov 4, 2025
8 checks passed
@emnul emnul deleted the update-readme branch November 4, 2025 15:21
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.

3 participants