Merged
Conversation
Change to only deploy MkDocs when merging a PR to main or pushing to main, as test updates should not update public docs. Removed unnecessary jobs that were already commented out and unnecessary commit action. Should resolve the workflow failures!
Update Deploy MkDocs.yml
# Optimize and Steps to Reduce Failures ## Changes - Define scoped paths to trigger workflow only if docs, the MkDocs config, or the workflow itself get updated. - Explicitly defined write permissions for contents. - Added concurrency setting to stop if a new instance of the workflow starts.
Update Deploy MkDocs.yml to resolve workflow errors: reduce triggers to only relevant changes, add concurrency checks, and specify explicitly scoped permissions.
SamErde
added
bug
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request synchronizes changes from main to testing by updating the MkDocs deployment workflow. Key changes include updating trigger conditions with file paths, adding job-level permissions and concurrency settings, and removing obsolete steps for building and committing markdown files.
Comments suppressed due to low confidence (1)
.github/workflows/Deploy MkDocs.yml:10
- The push trigger does not include a path for './mkdocs.yml' while the pull_request trigger does. This inconsistency could lead to unexpected behavior if changes are made to mkdocs.yml, so please verify if the omission is intentional.
paths: # Only deploy MkDocs when the contents of the docs folder change or when this workflow changes
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.
With fixes to the MkDocs workflow, this syncs those changes from main back to testing:
This pull request updates the
.github/workflows/Deploy MkDocs.ymlfile in testing to reflect fixes in main to the deployment process for MkDocs. The most important changes include updating the conditions for triggering the workflow, adding permissions and concurrency settings, and removing unnecessary steps.Workflow trigger updates:
.github/workflows/Deploy MkDocs.yml: Modified thepathsconfiguration to deploy MkDocs only when relevant files change.Permissions and concurrency settings:
.github/workflows/Deploy MkDocs.yml: Addedcontents: writepermissions and configured concurrency settings to cancel in-progress runs for the same workflow and reference.Removal of unnecessary steps:
.github/workflows/Deploy MkDocs.yml: Removed the step that combined markdown files to create the MkDocs index and repository readme file, as well as the git auto-commit action step.