GitHub

There are two main approaches to running ALCops in GitHub: using AL-Go for GitHub (the recommended path) or building your own GitHub Actions workflow.

AL-Go for GitHub

AL-Go for GitHub has built-in support for custom code analyzers through its settings file.

Add the customCodeCops property to your AL-Go settings.json (typically .github/AL-Go-Settings.json or the project-level settings file):

{
  "enableCodeCop": true,
  "customCodeCops": [
    ".alcops/ALCops.ApplicationCop.dll",
    ".alcops/ALCops.DocumentationCop.dll",
    ".alcops/ALCops.FormattingCop.dll",
    ".alcops/ALCops.LinterCop.dll",
    ".alcops/ALCops.PlatformCop.dll",
    ".alcops/ALCops.TestAutomationCop.dll",
    ".alcops/ALCops.Common.dll"
  ]
}

AL-Go downloads the DLLs at build time and passes them to the compiler automatically. For a full list of AL-Go settings, see the AL-Go advanced settings reference .

AL-Go Helper

ALCops provides a dedicated AL-Go helper that automates analyzer download and setup using AL-Go’s pipeline hook mechanism. This is the simplest way to keep your analyzers up to date.

1. Create a file called PipelineInitialize.ps1 in your .AL-Go folder.
2. Add the following content:

Param([Hashtable] $parameters)

# Configuration
$scriptUrl = "https://raw.githubusercontent.com/ALCops/AL-Go/v1.0.0/scripts/Install-ALCops.ps1"

# Download and run the installer script
$scriptPath = Join-Path ([System.IO.Path]::GetTempPath()) "Install-ALCops.ps1"
Invoke-WebRequest -Uri $scriptUrl -OutFile $scriptPath -UseBasicParsing

& $scriptPath

The installer runs during AL-Go’s PipelineInitialize stage, before compilation starts. It downloads the analyzer package from NuGet and stages the DLLs so AL-Go picks them up as custom code cops automatically.

Configuration Options

Pass parameters to Install-ALCops.ps1 to control the version and target framework:

Example with a specific version:

& $scriptPath -packageVersion "1.2.3"

Ruleset in AL-Go

To configure rule severity in AL-Go builds, place a .ruleset.json file in your project root. AL-Go picks it up automatically. See Configuration for the file format.