You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
added script (AI-generated) to pin all GitHub Actions to commit SHAs
updated workflows to use commit SHAs
added documentation for the new script
Why did you make the changes (we will use this info to test)?
SHA-pinning is for security, because the action tags can be re-pointed to malicious commits.
I had to reorganize the scripts documentation into a folder structure in order to add a page for the script.
I figured it's okay to let AI create the script, since it makes small changes that we would look at before committing.
Testing
Change .github/workflows/deploy-docs.yml- uses: actions/checkout@... line to - uses actions/checkout@v4 and run the script to see that it writes the SHA for it.
Pushed a fix for the 4 documentation links warnings.
Suggested changes
Switch autolinks to awesome-links
I'm looking at the autolinks plugin for mkdocs and it doesn't work very well with the awesome-pages plugin. The problem is it doesn't support multiple files named index.md in different directories, so I ended up specifying the full relative path, which defeats the purpose of the plugin.
There's another plugin called awesome-links that supports partial paths such as scripts/index.md and tools/index.md, which is better than autolinks
Pushed a fix for the 4 documentation links warnings.
Suggested changes
Switch autolinks to awesome-links
I'm looking at the autolinks plugin for mkdocs and it doesn't work very well with the awesome-pages plugin. The problem is it doesn't support multiple files named index.md in different directories, so I ended up specifying the full relative path, which defeats the purpose of the plugin.
There's another plugin called awesome-links that supports partial paths such as scripts/index.md and tools/index.md, which is better than autolinks
Update awesome-pages to awesome-nav
Looks like awesome-pages got renamed to awesome-nav, so we should probably switch to that too. The 2 awesome plugins are by the same developer, which explains why they work well together.
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
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.
Fixes #676
What changes did you make?
Why did you make the changes (we will use this info to test)?
Testing
.github/workflows/deploy-docs.yml- uses: actions/checkout@...line to- uses actions/checkout@v4and run the script to see that it writes the SHA for it.