Skip to content

v4.0.0

Choose a tag to compare

@github-actions github-actions released this 11 Oct 15:36
· 4 commits to main since this release
1783982

🌟[Major]: Remove Settings with predefined settings (#18)

Description

This pull request simplifies the configuration of the script analyzer action by removing the Settings input (which previously allowed selecting between Module, SourceCode, or Custom modes) in favor of always using a SettingsFilePath. Documentation, workflow, and implementation are updated to reflect this streamlined approach. Additionally, a new example settings file for source code analysis is added for clarity.

Configuration and API Simplification:

  • Removed the Settings input from action.yml, the workflow, and environment variables, so users now always specify a SettingsFilePath for analyzer configuration. The default settings file path is now .github/linters/.powershell-psscriptanalyzer.psd1. [1] [2] [3] [4] [5] [6] [7]

Documentation Updates:

  • Updated README.md to remove references to the old Settings input and predefined settings types, clarifying that users should provide a settings file via SettingsFilePath. Usage instructions and examples are revised accordingly. [1] [2] [3]

Implementation Changes:

  • Refactored scripts/main.ps1 to resolve only the SettingsFilePath and validate its existence, removing all logic related to the Settings input and its switch statement.

Test and Example Improvements:

  • Added a new tests/srcWithManifestTestRepo/tests/SourceCode.Settings.psd1 file containing example analyzer rules for source code analysis.