Skip to content
This repository was archived by the owner on Oct 21, 2026. It is now read-only.

README: take over the AL Runner v2 overview, name the binary al-runner - #391

Merged
StefanMaron merged 6 commits into
mainfrom
readme-merge
Oct 21, 2026
Merged

StefanMaron merged 6 commits into
mainfrom
readme-merge

Conversation

@StefanMaron

@StefanMaron StefanMaron commented Oct 21, 2026 •

Copy link
Copy Markdown
Owner

I merged the overview parts of the v2 README into the v3 README. Install, versions (edge and alpha), usage, flags, dependencies, trust and refusals, and building stay as they were. Only the names changed.

Merge order: first the pull request that points references at the aldevtools organization (branch move-references), then the pull request that renames the binary to al-runner (branch binary-al-runner), then this one. This branch is based on move-references. The README text about the v2 tool note and al-runner --version describes code that the rename pull request ships.

What I took from v2 (current README on the v2 branch, plus the April version, which had more description):

  • The one-line summary: no BC service tier, no Docker, no SQL Server, no BC license. I dropped "in milliseconds", because I have no measurement for v3 on a user's app.
  • "What it is": a standalone test runner for AL, meant as a quick check before the full BC pipeline, not a replacement for it.
  • The rule that unsupported features are reported, never answered with a guessed default.
  • License: a line that v2 on the v2 branch stays under MIT.

What I left out, because it is not true for v3:

  • v2's architecture: loading Microsoft's DLLs, Cecil patches, Roslyn, the .NET prerequisites.
  • Watch mode, the debug adapter (DAP), --precompile, --test-data with bcbak, the v2 flag table and exit codes, v2 cache paths.
  • v2's "What's Supported" list. I did not check each item against v3, so I point to docs/status.md.
  • v2's sections on agent tooling (C# language server, graphify) and on reporting gaps. v3 has its own report sections.

New at the top:

  • A note that v3 replaces v2: v2 is frozen on the v2 branch, the dotnet tool stays on NuGet, a link to docs/integrations/migrating-tools-to-v3.md, and that issue and pull request numbers below about 5570 refer to the old StefanMaron/al-runtime-rs repository.
  • A short section on the two al-runner commands when the v2 dotnet tool is also installed, with the uninstall command.

The command name is al-runner throughout. I did not change the Windows install folder (%LOCALAPPDATA%\alrunner\bin), the ALRUNNER_* variables or docs/alrunner-buckets.md, because the code still uses those names.

https://claude.ai/code/session_01MifNJNPViEXwK4p83TH2DQ

- New title BusinessCentral.AL.Runner and the v2 one-line summary (without
  the "milliseconds" claim, which is not measured for v3).
- Note that v3 replaces v2: v2 frozen on the v2 branch, the dotnet tool stays
  on NuGet, link to the tool migration guide, and that issue and PR numbers
  below about 5570 refer to the old StefanMaron/al-runtime-rs repository.
- "What it is": v2's description (standalone test runner, a quick check
  before the full BC pipeline, not a replacement) rewritten for v3.
- A short section on the two al-runner commands when the v2 dotnet tool is
  installed too.
- The command name is al-runner throughout. Install folder, ALRUNNER_*
  variables and file names are unchanged.
- License: v2 on the v2 branch stays MIT.

Install, versions, usage, flags, dependencies, trust and building are
unchanged.

Claude-Session: https://claude.ai/code/session_01MifNJNPViEXwK4p83TH2DQ
…older default and the PATH note variable

serve runs all requests in one process and keeps the last compile; the
README still said one child process per request. The rule that picks the
BC build without --bc-version also takes the build of Microsoft's own
tests and packages from --dep and --package-cache, and the target major
comes from app.json. Found in a docs-vs-behavior audit of the binary.

Claude-Session: https://claude.ai/code/session_01MifNJNPViEXwK4p83TH2DQ
@StefanMaron
StefanMaron enabled auto-merge October 21, 2026 06:58
@StefanMaron
StefanMaron merged commit de4cd2c into main Oct 21, 2026
7 checks passed
@StefanMaron
StefanMaron deleted the readme-merge branch October 21, 2026 07:15
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant