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

Conversation 0 Commits 5 Files changed 2 +18 -2

BaumiCoder commented 2026-02-19 17:15:52 +01:00

Owner

Copy link

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.

BaumiCoder added this to the Version 0.1.1 milestone 2026-02-19 17:15:52 +01:00

BaumiCoder added the

Kind

Bug

label 2026-02-19 17:15:52 +01:00

BaumiCoder self-assigned this 2026-02-19 17:15:52 +01:00

BaumiCoder added 1 commit 2026-02-19 17:15:53 +01:00

CI: Add "linter" to check behavior on docs.rs c9bd1d92a3

BaumiCoder added 1 commit 2026-02-19 17:37:33 +01:00

Do not use cargo-about at docs.rs ... 81df96e528

No need to collect the license informations for the docs.rs build.

BaumiCoder added 1 commit 2026-02-20 08:56:59 +01:00

CI: Fix docs.rs action ... 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

BaumiCoder added 1 commit 2026-02-20 09:46:49 +01:00

CI: Replace docs.rs action ... 43d69a4961

The action needs the command "gh", which is a GitHub CLI tool and
therefore not available in Forgejo actions.

BaumiCoder added 1 commit 2026-02-20 10:18:25 +01:00

CI: Fix docs.rs usage ... 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 referenced this pull request from a commit 2026-02-20 11:05:10 +01:00

Merge branch 'bugfix/28-docs.rs-build'

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.

Reviewers

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)

No labels

Compat/Breaking

EditorConfig

0.17.2

Kind

Bug

Kind

Chore

Kind

Documentation

Kind

Enhancement

Kind

Feature

Kind

Testing

Packaging

Priority

Critical

Priority

High

Priority

Low

Priority

Medium

Reviewed

Confirmed

Reviewed

Duplicate

Reviewed

Invalid

Reviewed

Won't Fix

Status

Abandoned

Status

Blocked

Status

Need More Info

WIP

Milestone

Clear milestone

No items

No milestone

Version 0.1.1

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

BaumiCoder

1 participant

Notifications

Subscribe

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

No description provided.