FuelLabs/sway

ci: handle mdbook build failures better

Open

#3,887 opened on Jan 25, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (61,702 stars) (5,421 forks)batch import
P: lowbugcigood first issue

Description

We have mdbook build steps in the CI that can be hard to troubleshoot upon failure:

image

Originally, this particular job was set up this way to emit logs because it would pass regardless of whether mdbook build succeeded or failed.

We should either fix the lack of logs being emitted here, or find another way to fail with logs if mdbook build fails.

Contributor guide

Tech stack
rustshell
Domain
ci cddevops
Issue type
devops
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of GitHub ActionsFamiliarity with shell scripting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
78
Research direction
Review the current CI workflow file at .github/workflows/ci.yml, specifically the mdbook build step (lines 130-143). The issue suggests two approaches: either fix the lack of log output or make the build fail with logs on failure. Investigate how mdbook build is invoked and determine why logs are suppressed. Consider using `set o pipefail` or ensuring the build command's stderr and stdout are captured. Check if there are any existing discussions in related issues or PRs.