Update Deploy MkDocs.yml #242
Merged
Conversation
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
# 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.
SamErde
added
documentation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the MkDocs deployment workflow to improve when and how the workflow is triggered as well as to better manage deployment concurrency.
- Trigger the workflow only when specific files/folders change.
- Add write permissions and concurrency settings to ensure that only one deployment runs at a time.
Comments suppressed due to low confidence (1)
.github/workflows/Deploy MkDocs.yml:13
- If 'mkdocs.yml' is in the repository root, the leading './' prefix might prevent the pattern from matching as expected. Consider removing the prefix to ensure consistent path matching with the other entries.
- './mkdocs.yml'
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.
This pull request includes updates to the
.github/workflows/Deploy MkDocs.ymlfile to improve the deployment process for MkDocs. The most important changes include specifying paths to trigger the workflow and adding permissions and concurrency settings.Workflow improvements:
.github/workflows/Deploy MkDocs.yml: Added paths to trigger the deployment workflow only when changes occur in theDocsfolder, the workflow file itself, or themkdocs.ymlfile..github/workflows/Deploy MkDocs.yml: Added write permissions for contents and set up concurrency settings to ensure that only one deployment runs at a time, canceling any in-progress deployments if a new one is triggered.