Action that runs quarto render to check for broken links and errors#237
Merged
noosheenv merged 56 commits intomainvalidmind/documentation:mainfrom Jul 10, 2024
noosheenvazinkhoo/sc-5241/create-github-action-to-run-quarto-rendervalidmind/documentation:noosheenvazinkhoo/sc-5241/create-github-action-to-run-quarto-renderCopy head branch name to clipboard
Merged
Action that runs quarto render to check for broken links and errors#237noosheenv merged 56 commits intomainvalidmind/documentation:mainfrom noosheenvazinkhoo/sc-5241/create-github-action-to-run-quarto-rendervalidmind/documentation:noosheenvazinkhoo/sc-5241/create-github-action-to-run-quarto-renderCopy head branch name to clipboard
noosheenv merged 56 commits intomainvalidmind/documentation:mainfrom
noosheenvazinkhoo/sc-5241/create-github-action-to-run-quarto-rendervalidmind/documentation:noosheenvazinkhoo/sc-5241/create-github-action-to-run-quarto-renderCopy head branch name to clipboard
Conversation
…o noosheenvazinkhoo/sc-5241/create-github-action-to-run-quarto-render
Co-authored-by: Nik Richers <nik@validmind.ai>
…o noosheenvazinkhoo/sc-5241/create-github-action-to-run-quarto-render
Contributor
Author
|
Summary of changes:
|
nrichers
reviewed
Jul 10, 2024
Collaborator
nrichers
left a comment
There was a problem hiding this comment.
@noosheenv re-reviewed and this looks good, except the new CI check runs even when the PR is in draft mode:
You can see in the screenshot that the release notes check was skipped — that's how it should be.
Contributor
Author
nrichers
approved these changes
Jul 10, 2024
Collaborator
nrichers
left a comment
There was a problem hiding this comment.
LGTM! (Looks GREAT to me.) Retested and your new GitHub workflow works as expected, including skipping when the PR is in draft mode. SHIP IT. 🚢
This file contains hidden or 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
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.
Internal Notes for Reviewers
I made a Github action to run
quarto renderto check for errors and broken links every time you push a commit.The file is called
render-site.yamland resides in the.github/workflowsfolder.The first few steps installs any necessary dependencies, such as Quarto and its associated extensions by using
quarto install extension. It also tells the action to run when someone either makes a new PR or pushes something.Then, it runs

quarto renderand checks for any immediate errors, like if you had something really off in the_quarto.ymlfile. Here's what it looks like when you try to push something with a big error:It shows the output and also displays a message saying Quarto failed immediately.
If there are no big errors,


quarto renderwill run in the background, which takes approximately 5 minutes. The workflow will then check the output for any instances of warnings or errors. If there are warnings, usually for broken links, the check will fail and display where the warning is. Here is an example:You can find a detailed view like the screenshot above by clicking on Details next to the Quarto render check like this:
If there are no errors or warnings, the check will pass.
Other changes:
There were still some issues with broken links relating to the name of the
NLP_and_LLMfolder, so some commits fix that. Also, some release notes were referencing our hackyNLP_and_LLMfolder, so upon fixing the folder name, the links were updated to referencenlp_and_llm.External Release Notes