Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configure PSSA to check for help comments #1492

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

james-garriss
Copy link
Collaborator

@james-garriss james-garriss commented Dec 24, 2024

🗣 Description

Modified the PSSA config file so that it checks for the presence of help comments for PowerShell functions. It does not check for validity or formatting (as per https://learn.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/rules/providecommenthelp?view=ps-modules).

Note: This check is considered to be of severity "information", so this problem does not currently cause the pipelines to fail.

💭 Motivation and context

Closes: #1489

🧪 Testing

Ran the CI and workflow pipelines.
Example of the results (with 148 missing help comments): https://github.com/cisagov/ScubaGear/actions/runs/12485122722/job/34843478350

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • All future TODOs are captured in issues, which are referenced in code comments.

See #1491

  • Related issues these changes resolve are linked preferably via [closing keywords]
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

  • Demonstrate changes to the team for questions and comments.
    (Note: Only required for issues of size Medium or larger)

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@james-garriss james-garriss added the enhancement This issue or pull request will add new or improve existing functionality label Dec 24, 2024
@james-garriss james-garriss added this to the Lionfish milestone Dec 24, 2024
@james-garriss james-garriss self-assigned this Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable PSSA to check for missing function comments
1 participant