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

the 'linkcheck' preprocessor should not block the build #566

Open
avivace opened this issue Sep 12, 2024 · 4 comments
Open

the 'linkcheck' preprocessor should not block the build #566

avivace opened this issue Sep 12, 2024 · 4 comments
Assignees
Labels
ci/cd Continuos Deployment and Integration pipelines

Comments

@avivace
Copy link
Member

avivace commented Sep 12, 2024

It often happens that PRs and commits are blocked from being built and pushed because unrelated (in other parts of the document) links now appear to be broken

@avivace avivace added the ci/cd Continuos Deployment and Integration pipelines label Sep 12, 2024
@ISSOtm
Copy link
Member

ISSOtm commented Sep 18, 2024

Well, they fail to build, but that doesn't prevent them from being pushed, does it?

@avivace
Copy link
Member Author

avivace commented Sep 20, 2024

@ISSOtm it blocks the build so nothing new gets published when a git commit gets pushed

@ISSOtm
Copy link
Member

ISSOtm commented Sep 21, 2024

Ah, fair.

Solution: split CI into two jobs, one running mdBook without linkcheck and publishing the results; the other running linkcheck.

This will still cause a CI failure, and thus raise red flags (or a red ❌, I guess), but not prevent deployment.

This can be achieved by using environment variables to override the output config, and disable some renderers, I believe.

@ISSOtm ISSOtm self-assigned this Sep 21, 2024
@avivace
Copy link
Member Author

avivace commented Sep 21, 2024

Okay I agree with what you proposed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/cd Continuos Deployment and Integration pipelines
Projects
None yet
Development

No branches or pull requests

2 participants