Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fail when mdbook build has errors #2780

Merged
merged 9 commits into from
Dec 17, 2024
Merged

Conversation

franciszekjob
Copy link
Collaborator

@franciszekjob franciszekjob commented Dec 14, 2024

Closes #2756

Introduced changes

Add a script which exits with code 1 in case when there are errors when running mdbook build. This should be ofc done on mdbook's project side, however it hasn't been addressed yet (rust-lang/mdBook#2277).

Example run with broken docs url:
https://github.com/foundry-rs/starknet-foundry/actions/runs/12329947653/job/34414855443

Checklist

  • Linked relevant issue
  • Updated relevant documentation
  • Added relevant tests
  • Performed self-review of the code
  • Added changes to CHANGELOG.md

@franciszekjob franciszekjob changed the title Franciszekjob/2756 fix Return exit code 1 when mdbook build fails Dec 14, 2024
@franciszekjob franciszekjob changed the title Return exit code 1 when mdbook build fails Fail when mdbook build has errors Dec 14, 2024
@franciszekjob franciszekjob marked this pull request as ready for review December 14, 2024 13:37
@franciszekjob franciszekjob added this pull request to the merge queue Dec 17, 2024
Merged via the queue into master with commit 62bc066 Dec 17, 2024
26 checks passed
@franciszekjob franciszekjob deleted the franciszekjob/2756-fix branch December 17, 2024 13:27
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.

Fix mdbook check action to make it fail on error
3 participants