1
1
Fork
You've already forked ecformat
0

Docs.rs build fails #34

Manually merged
BaumiCoder merged 5 commits from bugfix/28-docs.rs-build into main 2026年02月20日 11:05:12 +01:00

Resolves #28

User perspective

Makes documentation of ecformat (hopefully) available on docs.rs.

Developer perspective

For version 0.1.0 the build on ecformat failed due to the cargo install cargo-about call in the build.rs. The reason for this seems to be a limited network access during the build on docs.rs.

Now, the build.rs does not use cargo-about in case of docs.rs which is the same behavior as if ecformat is build as dependency. Furthermore, a "linter" job in CI checks if the build in a docs.rs-like setting works.

Resolves #28 ### User perspective Makes documentation of ecformat (hopefully) available on docs.rs. ### Developer perspective For version 0.1.0 the build on ecformat failed due to the `cargo install cargo-about` call in the `build.rs`. The reason for this seems to be a limited network access during the build on docs.rs. Now, the `build.rs` does not use `cargo-about` in case of docs.rs which is the same behavior as if ecformat is build as dependency. Furthermore, a "linter" job in CI checks if the build in a docs.rs-like setting works.
CI: Add "linter" to check behavior on docs.rs
All checks were successful
/ changes (pull_request) Successful in 51s
/ lint_reuse (pull_request) Successful in 1m12s
/ lint_codespell (pull_request) Successful in 1m4s
/ lint_ecformat (pull_request) Successful in 8m31s
/ test (pull_request) Successful in 58s
/ lint_cargo_deny (pull_request) Has been skipped
/ lint_clippy (pull_request) Has been skipped
/ lint_rustfmt (pull_request) Has been skipped
/ lint_taplo (pull_request) Has been skipped
/ lint_yamllint (pull_request) Has been skipped
/ lint_cargo_udeps (pull_request) Has been skipped
/ lint_docs_rs (pull_request) Has been skipped
c9bd1d92a3
Do not use cargo-about at docs.rs
Some checks failed
/ changes (pull_request) Successful in 50s
/ lint_reuse (pull_request) Successful in 1m11s
/ lint_codespell (pull_request) Successful in 1m4s
/ lint_ecformat (pull_request) Successful in 2m53s
/ test (pull_request) Successful in 4m15s
/ lint_cargo_deny (pull_request) Has been skipped
/ lint_clippy (pull_request) Successful in 3m49s
/ lint_rustfmt (pull_request) Successful in 1m59s
/ lint_taplo (pull_request) Has been skipped
/ lint_yamllint (pull_request) Has been skipped
/ lint_cargo_udeps (pull_request) Successful in 22m5s
/ lint_docs_rs (pull_request) Failing after 21s
81df96e528
 
No need to collect the license informations for the docs.rs build.
CI: Fix docs.rs action
Some checks failed
/ changes (pull_request) Successful in 51s
/ lint_reuse (pull_request) Successful in 1m11s
/ lint_codespell (pull_request) Successful in 1m4s
/ lint_ecformat (pull_request) Successful in 3m14s
/ test (pull_request) Successful in 3m53s
/ lint_cargo_deny (pull_request) Has been skipped
/ lint_clippy (pull_request) Successful in 3m10s
/ lint_rustfmt (pull_request) Successful in 1m55s
/ lint_taplo (pull_request) Has been skipped
/ lint_yamllint (pull_request) Has been skipped
/ lint_cargo_udeps (pull_request) Successful in 4m20s
/ lint_docs_rs (pull_request) Failing after 5m3s
b7961d8bdc
 
Last commit trigger first run of the job as relevant file was changed
and there this error message was shown:
Unable to resolve cargo-docs-rs@v1: Revision invalid :
reference must be defined once at the beginning
⚙️ [runner]: Revision invalid :
reference must be defined once at the beginning
CI: Replace docs.rs action
Some checks failed
/ changes (pull_request) Successful in 52s
/ lint_reuse (pull_request) Successful in 1m10s
/ lint_codespell (pull_request) Successful in 1m4s
/ lint_ecformat (pull_request) Successful in 3m22s
/ test (pull_request) Successful in 3m56s
/ lint_cargo_deny (pull_request) Has been skipped
/ lint_clippy (pull_request) Successful in 3m9s
/ lint_rustfmt (pull_request) Successful in 2m3s
/ lint_taplo (pull_request) Has been skipped
/ lint_yamllint (pull_request) Has been skipped
/ lint_cargo_udeps (pull_request) Successful in 4m18s
/ lint_docs_rs (pull_request) Failing after 2m43s
43d69a4961
 
The action needs the command "gh", which is a GitHub CLI tool and
therefore not available in Forgejo actions.
CI: Fix docs.rs usage
All checks were successful
/ changes (pull_request) Successful in 51s
/ lint_reuse (pull_request) Successful in 1m11s
/ lint_codespell (pull_request) Successful in 1m4s
/ lint_ecformat (pull_request) Successful in 3m22s
/ test (pull_request) Successful in 3m49s
/ lint_cargo_deny (pull_request) Has been skipped
/ lint_clippy (pull_request) Successful in 3m7s
/ lint_rustfmt (pull_request) Successful in 1m56s
/ lint_taplo (pull_request) Has been skipped
/ lint_yamllint (pull_request) Has been skipped
/ lint_cargo_udeps (pull_request) Successful in 4m20s
/ lint_docs_rs (pull_request) Successful in 4m33s
a7cbf36748
 
It uses a nightly option of rust. Error from the last run:
error: the `-Z` flag is only accepted on the nightly channel of Cargo,
but this is the `stable` channel
BaumiCoder manually merged commit a809a8b763 into main 2026年02月20日 11:05:12 +01:00
BaumiCoder changed title from (削除) WIP: Docs.rs build fails (削除ここまで) to Docs.rs build fails 2026年02月20日 11:05:45 +01:00
Sign in to join this conversation.
No reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
EditorConfig
0.17.2
 Issues to support version 0.17.2 of the EditorConfig specification
Kind
Bug
 Something is not working
Kind
Chore
 Some tasks maintainig tasks
Kind
Documentation
 Documentation changes
Kind
Enhancement
 Improve existing functionality
Kind
Feature
 New functionality
Kind
Testing
 Issue or pull request related to testing
Packaging
About packaging the project for some platform
Priority
Critical
 The priority is critical
Priority
High
 The priority is high
Priority
Low
 The priority is low
Priority
Medium
 The priority is medium
Reviewed
Confirmed
 Issue has been confirmed
Reviewed
Duplicate
 This issue or pull request already exists
Reviewed
Invalid
 Invalid issue
Reviewed
Won't Fix
 This issue won't be fixed
Status
Abandoned
 Somebody has started to work on this but abandoned work
Status
Blocked
 Something is blocking this issue or pull request
Status
Need More Info
 Feedback is required to reproduce issue or to continue work
WIP
Work in progress (Assignee is working on this issue)
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
BaumiCoder/ecformat!34
Reference in a new issue
BaumiCoder/ecformat
No description provided.
Delete branch "bugfix/28-docs.rs-build"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?