From 70ee36758ed7d330d5d5edf828fd20e2ef2f75a0 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 11 Mar 2026 17:12:53 +0000 Subject: [PATCH 1/2] Initial plan From edd9c9ea2fda264fcf4d990ece5ec99eb7d61b6c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 11 Mar 2026 17:14:45 +0000 Subject: [PATCH 2/2] Fix MD numbered lists to use 1. for all items in agent markdown files Co-authored-by: mazhelez <43066499+mazhelez@users.noreply.github.com> --- .github/agents/Documentation.md | 6 +++--- .github/agents/Security.md | 8 ++++---- .github/agents/Style.md | 8 ++++---- .github/agents/code-review.agent.md | 14 +++++++------- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.github/agents/Documentation.md b/.github/agents/Documentation.md index 865f89b62..c41ba3f8d 100644 --- a/.github/agents/Documentation.md +++ b/.github/agents/Documentation.md @@ -3,6 +3,6 @@ ## Important (Should Flag) 1. **Missing RELEASENOTES update**: User-facing changes without a release note entry -2. **Missing documentation for new settings**: New or changed AL-Go settings must be documented in `Scenarios/settings.md` (including purpose, type, default/required status, and which templates/workflows honor them) and represented in the settings schema (`Actions/.Modules/settings.schema.json`) with matching descriptions and correct metadata (`type`, `enum`, `default`, `required`). -3. **Missing documentation for new functions**: New public functions (exported from modules or used as entry points) should include comment-based help (e.g., `.SYNOPSIS`, `.DESCRIPTION`, parameter help) and be described in relevant markdown documentation when they are part of the public surface. -4. **Missing documentation for new workflows or user-facing behaviors**: New or significantly changed workflows/templates in `Templates/` must have corresponding scenario documentation (or updates) in `Scenarios/`, and new user-facing commands or actions must be documented in scenarios or `README.md`. +1. **Missing documentation for new settings**: New or changed AL-Go settings must be documented in `Scenarios/settings.md` (including purpose, type, default/required status, and which templates/workflows honor them) and represented in the settings schema (`Actions/.Modules/settings.schema.json`) with matching descriptions and correct metadata (`type`, `enum`, `default`, `required`). +1. **Missing documentation for new functions**: New public functions (exported from modules or used as entry points) should include comment-based help (e.g., `.SYNOPSIS`, `.DESCRIPTION`, parameter help) and be described in relevant markdown documentation when they are part of the public surface. +1. **Missing documentation for new workflows or user-facing behaviors**: New or significantly changed workflows/templates in `Templates/` must have corresponding scenario documentation (or updates) in `Scenarios/`, and new user-facing commands or actions must be documented in scenarios or `README.md`. diff --git a/.github/agents/Security.md b/.github/agents/Security.md index 2efc9bf36..445743d0c 100644 --- a/.github/agents/Security.md +++ b/.github/agents/Security.md @@ -3,7 +3,7 @@ ## Critical (Must Flag) 1. **Missing error handling**: Scripts must start with `$errorActionPreference = "Stop"; $ProgressPreference = "SilentlyContinue"; Set-StrictMode -Version 2.0` -2. **Secret leakage**: Any path where a secret value could appear in logs, error messages, or output without being masked via `::add-mask::` -3. **Path traversal**: File operations that don't validate paths stay within the workspace -4. **Missing `-recurse` on ConvertTo-HashTable**: After `ConvertFrom-Json`, always chain `| ConvertTo-HashTable -recurse` for case-insensitive access -5. **Deprecated settings**: Flag usage of settings listed in `DEPRECATIONS.md` +1. **Secret leakage**: Any path where a secret value could appear in logs, error messages, or output without being masked via `::add-mask::` +1. **Path traversal**: File operations that don't validate paths stay within the workspace +1. **Missing `-recurse` on ConvertTo-HashTable**: After `ConvertFrom-Json`, always chain `| ConvertTo-HashTable -recurse` for case-insensitive access +1. **Deprecated settings**: Flag usage of settings listed in `DEPRECATIONS.md` diff --git a/.github/agents/Style.md b/.github/agents/Style.md index d09131bbb..2b51743f2 100644 --- a/.github/agents/Style.md +++ b/.github/agents/Style.md @@ -3,11 +3,11 @@ ## Important (Should Flag) 1. **Missing tests**: New or modified functions should have corresponding Pester tests in `Tests/` -2. **Cross-platform issues**: Hardcoded path separators, PS5-only or PS7-only constructs -3. **Encoding omissions**: File read/write without explicit `-Encoding UTF8` -4. **YAML permissions**: Workflows without minimal permission declarations +1. **Cross-platform issues**: Hardcoded path separators, PS5-only or PS7-only constructs +1. **Encoding omissions**: File read/write without explicit `-Encoding UTF8` +1. **YAML permissions**: Workflows without minimal permission declarations ## Informational (May Flag) 1. Opportunities to use existing helper functions from `AL-Go-Helper.ps1` or shared modules -2. Inconsistent naming (should be PascalCase functions, camelCase variables) +1. Inconsistent naming (should be PascalCase functions, camelCase variables) diff --git a/.github/agents/code-review.agent.md b/.github/agents/code-review.agent.md index b94e88edb..4b93f895b 100644 --- a/.github/agents/code-review.agent.md +++ b/.github/agents/code-review.agent.md @@ -21,13 +21,13 @@ Detailed rules are organized in separate files: When reviewing changes: 1. Read the PR description to understand intent -2. Check each changed file against the critical and important rules in [Security.md](./Security.md) and [Style.md](./Style.md) -3. Verify that test coverage exists for logic changes -4. Check for deprecated setting usage against `DEPRECATIONS.md`, and ensure any deprecations are documented there with clear replacement guidance and reflected in settings documentation/schema descriptions. -5. Validate that workflows follow the existing patterns in `Templates/` -6. Confirm that any new or modified settings are both documented and added to the schema, with aligned descriptions and correct metadata (type/default/enum/required). See [Documentation.md](./Documentation.md). -7. Confirm that new public functions have appropriate documentation, including accurate comment-based help (parameter names and descriptions kept in sync with the implementation). -8. Confirm that new or significantly changed workflows/templates and other user-facing behaviors are documented in the appropriate scenario files and/or `README.md`, and that any breaking changes are called out in `RELEASENOTES.md`. +1. Check each changed file against the critical and important rules in [Security.md](./Security.md) and [Style.md](./Style.md) +1. Verify that test coverage exists for logic changes +1. Check for deprecated setting usage against `DEPRECATIONS.md`, and ensure any deprecations are documented there with clear replacement guidance and reflected in settings documentation/schema descriptions. +1. Validate that workflows follow the existing patterns in `Templates/` +1. Confirm that any new or modified settings are both documented and added to the schema, with aligned descriptions and correct metadata (type/default/enum/required). See [Documentation.md](./Documentation.md). +1. Confirm that new public functions have appropriate documentation, including accurate comment-based help (parameter names and descriptions kept in sync with the implementation). +1. Confirm that new or significantly changed workflows/templates and other user-facing behaviors are documented in the appropriate scenario files and/or `README.md`, and that any breaking changes are called out in `RELEASENOTES.md`. ## Key Repository Knowledge