Skip to main content
AL-Go for GitHub is a set of GitHub templates and actions that provide professional DevOps processes for your Business Central AL projects. This guide will walk you through creating your first AL-Go repository and developing your first app.

Prerequisites

Before you begin, make sure you have:
  • A GitHub account
  • VS Code with the following extensions installed:
    • AL Language
    • Git
    • PowerShell
  • Docker Desktop installed and running locally

Choose Your Template

AL-Go for GitHub provides two template repositories depending on your project type:

AL-Go-PTE

For Per Tenant Extensions - Start here if you’re building extensions for specific Business Central tenants

AL-Go-AppSource

For AppSource Apps - Start here if you’re building apps to publish on Microsoft AppSource
This quickstart uses the AL-Go-PTE template. The process is nearly identical for AppSource apps.

Create Your Repository

1

Create from template

Navigate to https://github.com/microsoft/AL-Go-PTE and click Use this template, then select Create a new repository.Use this template
2

Configure repository

Enter a repository name (e.g., app1), choose whether to make it Public or Private, and click Create Repository.Create repository
3

Create your first app

In your new repository:
  1. Go to ActionsShow more workflows…
  2. Select Create a new appRun workflow
  3. Fill in the form:
    • Name: Your app name
    • Publisher: Your publisher name
    • ID range: e.g., 55000..55100
    • Direct Commit: ✓ (checked)
  4. Click Run workflow
Create a new app
4

Wait for completion

Wait for the workflow to complete. You can monitor progress in the Actions tab.Wait for completion

Set Up Local Development

1

Clone the repository

  1. In your GitHub repository, click the Code button and copy the HTTPS clone URL
  2. Open VS Code
  3. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
  4. Select Git Clone
  5. Paste the clone URL and select a local folder
Clone repository
2

Open the workspace

When prompted, open the cloned repository and then open the workspace file when VS Code asks you.
You can rename the al.code-workspace file to something more descriptive to distinguish between multiple workspaces.
3

Run the local development environment script

  1. In VS Code, navigate to the .AL-Go folder
  2. Open the localDevEnv.ps1 script
  3. Click Run to execute the PowerShell script
Run localDevEnv
4

Configure your local container

Answer the prompts:
  • Container name: Choose a name for your local Business Central container
  • Authentication mechanism: Select your preferred authentication (e.g., UserPassword)
  • Credentials: Provide username and password
  • License file: Select none for development
The script may ask for permissions to run Docker commands. Click Yes when prompted.
Wait for the script to complete. This may take several minutes as it downloads and sets up the Business Central container.LocalDevEnv completed

Start Developing

1

Clear credentials cache

Press Ctrl+Shift+P in VS Code and select AL: Clear Credentials Cache.
2

Modify and test your app

  1. Open the HelloWorld.al file in your app folder
  2. Modify the message string to personalize it
  3. Press F5 to compile and deploy
Modify Hello World
3

View your app in Business Central

When prompted, enter the credentials you provided earlier. Business Central will open in your browser.Navigate to Customers and see your customized Hello World message!Hello World in Business Central

Commit Your Changes

1

Review changes

Back in VS Code, you’ll notice that in addition to your HelloWorld.al changes, the launch.json file was also modified with your local environment information.
2

Stage, commit, and sync

  1. Stage your changes (click the + icon in the Source Control panel)
  2. Enter a commit message
  3. Click Commit
  4. Click Sync Changes to push to GitHub
Commit changes
3

View the CI/CD workflow

  1. Go back to your repository on github.com
  2. Click Actions to see your workflows running
  3. Wait for the build to complete
Actions running
4

Inspect build artifacts

When the build completes:
  1. Click on the completed workflow
  2. View the Build summary to see artifacts created
  3. Expand the build job and explore the Run Pipeline section to see compilation details
Build summary

Next Steps

Congratulations! You’ve successfully created your first AL-Go for GitHub repository and developed your first app. Here’s what you can explore next:

Add Tests

Learn how to add automated testing to your project

Set Up Deployment

Register environments for continuous deployment

Create a Release

Package and release your application

Take the Workshop

Complete the full AL-Go workshop for in-depth learning

Troubleshooting

If you encounter issues during setup, check that:
  • Docker Desktop is running
  • You have sufficient disk space for the Business Central container
  • Your network allows downloading container images
  • You’re using compatible versions of VS Code extensions
For more help, visit the AL-Go for GitHub repository or check the usage scenarios.

Build docs developers (and LLMs) love