Skip to content

ci: validate the interop object alone with rocfl - #5

Merged
adammharris merged 1 commit into
mainfrom
agent/backlog-fix-rocfl-check-fails-on-a-valid-object
Nov 1, 2026
Merged

adammharris merged 1 commit into
mainfrom
agent/backlog-fix-rocfl-check-fails-on-a-valid-object

Conversation

@adammharris

Copy link
Copy Markdown
Member

What changed

The Validate it with rocfl step in .github/workflows/ci.yml now runs

rocfl -r "$RUNNER_TEMP/interop" validate --paths interop-object

and rocfl's exit status decides the step. The pipefail / tee / grep wrapper is gone. The README's interop instructions name the object the same way, and the task is marked done.

Why

rocfl 1.7.0 treats the interop directory as a storage root. That directory has no root declaration, so rocfl reports E069 and exits 2 however valid the object is. Under set -e and pipefail the step stopped before the grep that was meant to tell this apart from an object error. As a result, rocfl cross-validation has failed on every push to main. Naming the object makes rocfl check the object alone.

Closes docs/tasks/rocfl-check-fails-on-a-valid-object.md.

Verification

On hbox, with cargo install rocfl --no-default-features --locked (1.7.0), against the object cargo test --test interop writes:

  • old command, rocfl -r $OUT validate: exit 2 (the failure on main)
  • new command, rocfl -r $OUT validate --paths interop-object: exit 0, "valid with warnings"
  • new command after appending a byte to v1/content/letter.md: exit 2, E092 fixity failure, so a bad object still fails the job

The test / clippy / fmt job's commands also pass locally: cargo fmt --all --check, cargo clippy --all-targets -- -D warnings, cargo test --all-targets with OCFL_FIXTURES set, and cargo test --doc. This PR's own CI run is the check of the workflow itself.

rocfl 1.7.0 validating the interop directory as a storage root reports the missing root declaration (E069) and exits 2, and under set -e and pipefail the step stopped before its grep could tell that apart from an object error, so the job failed on every push although the object was valid. Name the object with --paths interop-object and let rocfl's exit status decide: 0 for the object the interop test writes, 2 once a content file fails fixity (E092).
@adammharris
adammharris merged commit 21cd5e9 into main Nov 1, 2026
3 checks passed
@adammharris
adammharris deleted the agent/backlog-fix-rocfl-check-fails-on-a-valid-object branch November 1, 2026 22:36
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