[ci] check PowerShell scripts with PSScriptAnalyzer (part 1) #6704
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
jameslamb
approved these changes
Oct 29, 2024
There was a problem hiding this comment.
Thanks! The script changes look great to me... I agree with the choice of rules and and verbs. Thanks for the links in the description... I was not familiar with this concept of "approved verbs" in powershell before.
I just left one small suggestion on test.sh. Marking this "Approve", so you can merge without needing a new review from me if you agree with that suggestion.
.ci/test.sh
Outdated
| @@ -110,6 +110,9 @@ if [[ $TASK == "lint" ]]; then | |||
| 'r-lintr>=3.1.2' | |||
| # shellcheck disable=SC1091 | |||
| source activate "${CONDA_ENV}" | |||
| pwsh -command "Install-Module -Name PSScriptAnalyzer -Scope CurrentUser -SkipPublisherCheck" | |||
| echo "Linting PowerShell code" | |||
| pwsh -file "./.ci/lint-powershell.ps1" || exit 0 | |||
There was a problem hiding this comment.
Because this doesn't require anything installed with conda (we're relying on the pwsh that comes pre-installed on the runner), I think we should move this up to before conda create. Two reasons:
- prevents the case where we wait for
conda installto complete (which can sometimes take a few minutes) and then find out that the job is going to fail because of issues found byPSScriptAnalyzer. - prevents where
source activate "${CONDA ENV}"modifies the environment in a way that causes issues forpwsh(e.g. changesPATH/LD_LIBRARY_PATHand causes an incompatible mix of libraries to be loaded)
There was a problem hiding this comment.
Good catch! Totally makes sense. Will push changes right now.
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.
Linking full original PR: #6700.
This PR fixes all warnings about our own functions (
PSUseApprovedVerbs,PSUseShouldProcessForStateChangingFunctions,PSUseSingularNouns).Also this PR makes params in our own functions mandatory where needed.
List of available rules: https://github.com/PowerShell/PSScriptAnalyzer/blob/main/docs/Rules/README.md.
List of Approved Verbs for PowerShell Commands: https://learn.microsoft.com/en-us/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands?view=powershell-7.4.