Skip to content

Conversation

@arr00
Copy link
Contributor

@arr00 arr00 commented Dec 18, 2025

This PR bumps the version of @openzeppelin/docs-utils to a version that patched a bug for docs generation. It also reverts a change which resulted in api docs generation failing.

PR Checklist

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

@arr00 arr00 requested a review from a team as a code owner December 18, 2025 15:40
@changeset-bot
Copy link

changeset-bot bot commented Dec 18, 2025

⚠️ No Changeset found

Latest commit: 00a1cf4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@socket-security
Copy link

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updatednpm/​@​openzeppelin/​docs-utils@​0.1.5 ⏵ 0.1.6751008783 -2100

View full report

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 18, 2025

Walkthrough

The pull request contains two changes: modifications to docs/templates/properties.js that add array spreading ([...]) to findAll() results before applying filter operations, ensuring the filter operates on an explicit array rather than a potentially non-array iterable; and an update to package.json that increments the @openzeppelin/docs-utils devDependency from version ^0.1.5 to ^0.1.6.

Suggested labels

ignore-changeset

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Fix docs generation' accurately summarizes the main change: fixing documentation generation by bumping a dependency version and reverting a problematic change.
Description check ✅ Passed The description clearly explains the PR purpose: bumping @openzeppelin/docs-utils version to fix a bug and reverting a change that broke api docs generation, which directly relates to the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1eadb10 and 00a1cf4.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (2)
  • docs/templates/properties.js (1 hunks)
  • package.json (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-04T09:13:21.278Z
Learnt from: Amxx
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/crosschain/ERC7786Recipient.sol:3-3
Timestamp: 2025-09-04T09:13:21.278Z
Learning: In OpenZeppelin contracts, hardhat.config.js uses a sophisticated yargs-based configuration where the Solidity compiler version is set via argv.compiler (line 77) with a default of '0.8.27' defined in the yargs options (line 21), allowing flexible command-line overrides while maintaining a consistent default.

Applied to files:

  • package.json
📚 Learning: 2025-09-04T09:13:21.278Z
Learnt from: Amxx
Repo: OpenZeppelin/openzeppelin-contracts PR: 5904
File: contracts/crosschain/ERC7786Recipient.sol:3-3
Timestamp: 2025-09-04T09:13:21.278Z
Learning: In OpenZeppelin contracts, hardhat.config.js uses yargs to configure the Solidity compiler version dynamically via command line arguments, with a default of '0.8.27' set on line 21 and the solidity configuration using argv.compile around lines 76-87, rather than hardcoded version strings.

Applied to files:

  • package.json
⏰ 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). (9)
  • GitHub Check: Redirect rules - solidity-contracts
  • GitHub Check: Header rules - solidity-contracts
  • GitHub Check: Pages changed - solidity-contracts
  • GitHub Check: tests
  • GitHub Check: coverage
  • GitHub Check: slither
  • GitHub Check: tests-upgradeable
  • GitHub Check: tests-foundry
  • GitHub Check: halmos
🔇 Additional comments (2)
package.json (1)

64-64: Package version 0.1.6 is available on npm with no known security vulnerabilities.

Version 0.1.6 of @openzeppelin/docs-utils is available on npm and was published 6 months ago. No known security vulnerabilities or advisories were found for this package.

docs/templates/properties.js (1)

68-69: Good fix: Ensures filter operates on a concrete array.

The explicit array spread [...findAll()] ensures that .filter() operates on a proper array rather than a potentially non-array iterable. Verification confirms this is the correct approach and consistent with other usages across the codebase that either use Array.from() conversion or apply iterables directly in for...of loops where conversion is unnecessary.


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

@Amxx Amxx added the documentation Inline comments, guides, and examples. label Dec 19, 2025
@arr00 arr00 requested a review from ernestognw January 6, 2026 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Inline comments, guides, and examples. ignore-changeset

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants