Skip to content

chore: regenerate stdlib docs in release-please PR - #12589

Merged
TomAFrench merged 1 commit into
masterfrom
tf/release-regenerate-stdlib-docs
May 7, 2026
Merged

chore: regenerate stdlib docs in release-please PR#12589
TomAFrench merged 1 commit into
masterfrom
tf/release-regenerate-stdlib-docs

Conversation

@TomAFrench

Copy link
Copy Markdown
Member

Summary

  • Adds a new update-stdlib-docs job to the release workflow that rebuilds nargo, runs nargo doc in noir_stdlib/, and commits the regenerated noir_stdlib/docs/ back to the release-please branch.
  • Sequenced between update-acvm-workspace-package-versions and update-docs so the three jobs that push to the release branch don't race, and added to release-end's needs so a failure flips the sticky-comment warning on.

Since #12377 tied the stdlib version string to nargo's version, every release-please PR bumps the version embedded in the generated stdlib docs. The existing CI check in test-js-packages.yml then fails because the committed noir_stdlib/docs/ is stale. This job keeps them in sync automatically.

Closes #12406

Test plan

  • Next release-please PR is created and the new job runs, pushes a commit regenerating noir_stdlib/docs/, and the stdlib doc CI check passes on that PR.

@TomAFrench
TomAFrench requested a review from a team May 7, 2026 18:11

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'ACVM Benchmarks'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite Current: 5c461d7 Previous: 884cef8 Ratio
perfectly_parallel_batch_inversion_opcodes 2645725 ns/iter (± 6861) 2121803 ns/iter (± 977) 1.25

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Test Suite Duration'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite Current: 5c461d7 Previous: 884cef8 Ratio
test_report_zkpassport_noir-ecdsa_ 4 s 3 s 1.33

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Brillig Execution Time'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite Current: 5c461d7 Previous: 884cef8 Ratio
private-kernel-tail 0.005 s 0.004 s 1.25
rollup-block-root 0.003 s 0.002 s 1.50
rollup-root 0.002 s 0.001 s 2

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Brillig Compilation Time'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite Current: 5c461d7 Previous: 884cef8 Ratio
rollup-block-root-single-tx 2.02 s 1.45 s 1.39
rollup-root 1.776 s 1.462 s 1.21

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Execution Time'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite Current: 5c461d7 Previous: 884cef8 Ratio
rollup-block-root-single-tx 0.003 s 0.002 s 1.50
rollup-root 0.003 s 0.002 s 1.50

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Elaboration Time'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite Current: 5c461d7 Previous: 884cef8 Ratio
rollup-block-root-single-tx 1.72 s 1.19 s 1.45
rollup-root 1.43 s 1.168 s 1.22

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Compilation Time'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite Current: 5c461d7 Previous: 884cef8 Ratio
rollup-block-root-single-tx 2.12 s 1.48 s 1.43
rollup-root 1.906 s 1.566 s 1.22

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

@TomAFrench
TomAFrench added this pull request to the merge queue May 7, 2026
Merged via the queue into master with commit 4690c50 May 7, 2026
184 of 185 checks passed
@TomAFrench
TomAFrench deleted the tf/release-regenerate-stdlib-docs branch May 7, 2026 19:27
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.

CI broken in release-please PR

2 participants