Skip to content

Try the docs.rs build action in parallel CI - #3014

Merged
Sebastian Thiel (Byron) merged 1 commit into
mainfrom
docs-rs-action
Sep 23, 2026
Merged

Sebastian Thiel (Byron) merged 1 commit into
mainfrom
docs-rs-action

Conversation

@Byron

@Byron Byron commented Sep 23, 2026 •

Copy link
Copy Markdown
Member

Tasks

This section is for Byron only. Models continuing this PR must not add, remove, check, uncheck, rename, or reorder checkboxes here.

  • refackiew

Everything below this line was generated by Codex GPT-6.

Created by Codex on behalf of Byron. Byron will review before this is ready to merge.

The new docs.rs (beta) job builds the packaged gix library in the docs.rs sandbox using its existing documentation metadata. It starts alongside the other CI jobs, tolerates action failures, and is explicitly excluded from the Tests pass dependencies so it cannot delay the merge gate.

The trusted docs.rs action is pinned to a80e3fda4b96c307a0e1cd663166cfda9fc1c7ce, with a comment to replace the beta snapshot and its two release-tag lint exceptions with a versioned release. Its existing caches preserve the build runner and rustwide workspace; the full docs.rs Docker image is pulled by the action.

Validation

  • Confirmed the independent docs.rs action was absent before this change; checked the resulting YAML, parallel scheduling, nonblocking classification, action pin, gix selection, and checkout credentials.
  • actionlint 1.7.12 passes with ShellCheck disabled because it misclassifies existing Windows steps in mixed-OS jobs as Bash.
  • Pedantic zizmor 1.30.1 reports exactly the same eight findings as the base commit, with none introduced here.
  • codex review --commit 321cffbe2dab224795c6d01cc9ca31942121adc9 completed without findings. The action and its caches were independently inspected at the pinned upstream revision.
  • git diff --check passes. GitHub's online zizmor check passed and automatically resolved both beta release-tag review findings.
  • The first beta run took 6m53s and saved both caches. The second run hit both caches, skipped runner installation, and took 4m06s. Both ran alongside the other CI jobs and remained nonblocking when documentation failed.

Observed build result

The action successfully packages gix and starts the docs.rs sandbox, then reports E0425: cannot find type State in crate gix_note. The packaged crate uses published gix-note 0.1.1, while the checkout uses the newer gix_note::State API introduced after that release in 0418bf8c00. That dependency needs to be released and the gix dependency requirement updated before the packaged documentation can succeed. This is a publication-readiness failure exposed by the action; the beta job intentionally tolerates it.

The existing nonblocking cargo-deny-advisories check also reports RUSTSEC-2026-0306 for faster-hex 0.10.0, matching the base commit's CI. Required CI, including the Tests pass gate, CodeQL, CIFuzz, and zizmor, passed on 321cffb. All 32 other checks passed; this pre-existing advisory check is the only remaining red check.

Reported issue

$issue-full-auto try to get this action going. Definitely make sure it's running in parallel, and ideally cached. Oh, and make clear it's a beta - we'd not want 'Vlad Vannov (@main)' later. Lastly, know the people making it are trusted.

We’re looking for beta testers for the new
docs.rs build action!
It checks your crate’s documentation using the docs.rs build environment,
helping catch metadata, system dependency, read-only filesystem, and memory
issues before publishing. Add this after your checkout step; continue-on-error
keeps failures from blocking CI while you try it:

- uses: rust-lang/docs.rs/github-actions/build@main
  continue-on-error: true
  with:
    package: your-crate

Please report problems in
docs.rs issues, or ask here in
this thread.

Comment thread .github/workflows/ci.yml Fixed
Comment thread .github/workflows/ci.yml Fixed
<!-- agent -->
Port 8523d62 to fix
`RUSTSEC-2026-0306`. The safe `hex_decode_unchecked()` API in
`faster-hex` 0.10.0 can read beyond short input on the AVX2 path; the
0.10.1 backport fixes it without an API migration.

Require the patched version in `gix-hash` and `gix-packetline`, preserving
this branch's `thiserror` dependency in the latter, and update `Cargo.lock`.

Clear the remaining Cargo deny warnings by upgrading yanked `chacha20`
0.10.1 to 0.10.2, dropping the obsolete `RUSTSEC-2024-0436`,
`RUSTSEC-2026-0118`, and `RUSTSEC-2026-0119` ignores, and removing the
unused `OpenSSL` license allowance. Keep the applicable `async-std` ignore.

Assisted-by: GPT 6.0
Co-authored-by: GPT 6.0 <codex@openai.com>
@Byron
Sebastian Thiel (Byron) marked this pull request as ready for review September 23, 2026 19:29
@Byron
Sebastian Thiel (Byron) merged commit 1a3dc49 into main Sep 23, 2026
31 checks passed
@Byron

Byron commented Sep 23, 2026

Copy link
Copy Markdown
Member Author

Merged as it's only a cargo-deny fix, and these jobs already passed.

@Byron
Sebastian Thiel (Byron) deleted the docs-rs-action branch September 23, 2026 19:32

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 36bcd6f853

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

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

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

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "Codex (@codex) address that feedback".

Comment thread gix-hash/Cargo.toml

bstr = { version = "1.12.0", optional = true, default-features = false, features = ["alloc"] }
faster-hex = { version = "0.10.0", default-features = false, features = ["std"] }
faster-hex = { version = "0.10.1", default-features = false, features = ["std"] }

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.

P1 Badge Add the docs.rs CI job described by this commit

This commit changes dependencies and deny.toml, but .github/workflows/ci.yml is byte-for-byte identical to the parent; a repository-wide search of the target tree also finds neither rust-lang/docs.rs/github-actions/build nor a docs.rs (beta) job. Consequently, merging this commit will never invoke the advertised docs.rs build, run it in parallel, or exercise its caching/nonblocking configuration; the intended workflow patch appears to have been replaced by an unrelated dependency-security patch.

Useful? React with 👍 / 👎.

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.

2 participants