Skip to content

Conversation

@MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Feb 21, 2025

Description

This pull request includes several changes to improve the GitHub Actions workflows, update the documentation, and enhance the PSScriptAnalyzer settings.

Documentation Updates

  • Updated README.md to improve clarity, add dependencies, and update the example workflow section.
  • Added a new Settings.md file to document the PSScriptAnalyzer settings file format and key configuration options.

Custom PSScriptAnalyzer Settings

  • Added a new workflow configuration file .github/workflows/Action-Test-Src-Default-Custom.yml to run tests showing that the Custom settings and a SettingsPath works as it should.
  • Added a new custom settings file tests/srcTestRepo/tests/Custom.Settings.psd1 with specific rules and configurations for PSScriptAnalyzer.
  • Fixed scripts/tests/PSScriptAnalyzer/PSScriptAnalyzer.Tests.ps1 to include new log outputs and rule evaluation logic. This now skips tests as per the settings file that is used.

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

…stom.Settings.psd1; add test script demonstrating poor PowerShell practices
…or improved logging in PSScriptAnalyzer tests
@MariusStorhaug MariusStorhaug changed the title Obay settings 🩹 [Patch]: Obay settings Feb 22, 2025
@MariusStorhaug MariusStorhaug changed the title 🩹 [Patch]: Obay settings 🩹 [Patch]: Obay settings for skips Feb 22, 2025
@MariusStorhaug MariusStorhaug changed the title 🩹 [Patch]: Obay settings for skips 🩹 [Patch]: Obey settings for skips Feb 22, 2025
@MariusStorhaug MariusStorhaug merged commit f741c1e into main Feb 22, 2025
10 checks passed
@MariusStorhaug MariusStorhaug deleted the ObaySettings branch February 22, 2025 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants