Build and Publish docs only if there are no broken links #369
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dpoulopoulos
added
bug
Currently, we have two workflows named "Build and publish docs." The first workflow builds the documentation using Sphinx and publishes it to GitHub Pages, while the second checks for broken links. As a result, there is no unique reference for either workflow. Rename the link checker GitHub action to make it uniquely identifiable for use in other workflows. Refs #368 Signed-off-by: Dimitris Poulopoulos <[email protected]>
Rename the GHA YAML files to begin with a verb that clearly expresses their intent, for consistency. Signed-off-by: Dimitris Poulopoulos <[email protected]>
Run the "Build and publish docs" workflow only if the "Link checker" workflow completes successfully. Closes #368 Signed-off-by: Dimitris Poulopoulos <[email protected]>
dpoulopoulos
force-pushed
the
workflow-runs
branch
from
54ec5f7 to
6a07fa3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's changing
Currently, we have two separate workflows related to documentation:
However, we don't want the second workflow to run if the first one fails, as this would result in broken links being published on the documentation page.
Make the "Build and publish docs" workflow depend on the successful completion of the "Link checker" workflow to address this issue.
Closes #368