Skip to content

Add cloud agent instructions for issue-assigned agents#2248

Open
Copilot wants to merge 6 commits into
mainfrom
copilot/add-instructions-for-cloud-agents
Open

Add cloud agent instructions for issue-assigned agents#2248
Copilot wants to merge 6 commits into
mainfrom
copilot/add-instructions-for-cloud-agents

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 11, 2026

❔What, Why & How

Adds .github/agents/issue.instructions.md — instructions for cloud agents that get assigned to issues and create PRs.

Basic PR requirements:

  • When to update RELEASENOTES.md (action/template/workflow changes, bug fixes)
  • Test expectations: Pester naming conventions, cross-platform (PS5/PS7), mocking
  • Documentation: settings in Scenarios/settings.md + settings.schema.json, scenario docs
  • Code quality: standard header, secret masking, encoding, JSON handling

Repository architecture reference:

  • Action anatomy: action.yamlInvoke-AlGoAction.ps1<Action>.ps1AL-Go-Helper.ps1
  • Template layout: PTE vs AppSource variants, which workflows are shared
  • Module structure under Actions/.Modules/
  • Test organization and CI matrix

Step-by-step guides for adding features:

  • Adding/modifying settings (code → schema → docs → tests)
  • Adding a new action (folder, action.yaml, script, tests, workflow integration)
  • Adding/modifying workflows (dual-template consistency, YAML conventions)
  • Modifying shared helpers (caller analysis, backward compat)

Common pitfalls section covering dual-template sync, path separators, PS5/PS7 differences, schema drift.

Clarifications added from review feedback:

  • Explicitly notes that $errorActionPreference (camelCase) is this repo's convention, so agents don't confuse it with canonical PowerShell casing.
  • Clarifies the shell convention distinction: template workflows use powershell, the repo's own CI workflows use pwsh.

✅ Checklist

  • Add tests (E2E, unit tests) — N/A, documentation-only change
  • Update RELEASENOTES.md — N/A, internal tooling, not user-facing
  • Update documentation (e.g. for new settings or scenarios) — this is the documentation
  • Add telemetry — N/A

Copilot AI and others added 2 commits May 11, 2026 21:11
@mazhelez mazhelez marked this pull request as ready for review May 11, 2026 21:17
@mazhelez mazhelez requested a review from a team as a code owner May 11, 2026 21:17
Copilot AI review requested due to automatic review settings May 11, 2026 21:17
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a dedicated instruction document for cloud agents assigned to issues, outlining required PR hygiene, repository architecture, and step-by-step guidance for implementing changes in AL-Go for GitHub.

Changes:

  • Introduces a new cloud-agent instruction guide under .github/agents/.
  • Documents required PR checklist items (release notes, tests, documentation, code quality).
  • Summarizes repo architecture and common pitfalls to reduce incorrect PRs.

Comment thread .github/agents/issue.instructions.md Outdated
Comment thread .github/agents/issue.instructions.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@mazhelez
Copy link
Copy Markdown
Collaborator

@copilot apply changes based on the comments in this thread

…tion distinction

Agent-Logs-Url: https://github.com/microsoft/AL-Go/sessions/9476e7e2-74ab-4ef7-8f2a-b561e9e1cdd7

Co-authored-by: mazhelez <43066499+mazhelez@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 12, 2026

@copilot apply changes based on the comments in this thread

Applied in 17f0d5d:

  • Clarified that $errorActionPreference (camelCase) is this repo's convention, added a note to the snippet so agents don't second-guess it.
  • Fixed the pwsh vs powershell contradiction: line 49 now explicitly distinguishes template workflows (powershell) from the repo's own CI workflows (pwsh).

Copilot AI requested a review from mazhelez May 12, 2026 12:47
@mazhelez
Copy link
Copy Markdown
Collaborator

@copilot please fix the pre-commit errors

Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 12, 2026

@copilot please fix the pre-commit errors

Fixed in d4eefe1. The mdformat hook was reformatting numbered lists (e.g., 2.1.) and horizontal rules (---______________________________________________________________________). Ran mdformat --end-of-line=keep to apply the expected formatting.

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.

4 participants