Skip to main content
The Create Development Environment action creates a new Business Central online development environment or reuses an existing one. It can automatically update your repository configuration with the environment details.

Usage

- uses: microsoft/AL-Go/Actions/[email protected]
  with:
    environmentName: 'MyDevEnv'
    adminCenterApiCredentials: ${{ secrets.ADMIN_CENTER_API_CREDENTIALS }}

Inputs

shell
string
default:"powershell"
Shell in which you want to run the action (powershell or pwsh)
actor
string
default:"${{ github.actor }}"
The GitHub actor running the action
token
string
default:"${{ github.token }}"
The GitHub token running the action
environmentName
string
required
Name of the online environment to create
project
string
default:"."
Project name if the repository is setup for multiple projectsUse . for the root project or specify a project folder name.
adminCenterApiCredentials
string
default:""
Admin center API credentials for authenticating with the Business Central Admin CenterShould be stored as a secret in your repository.
reUseExistingEnvironment
boolean
default:"false"
Reuse environment if it exists?When true, the action will use an existing environment with the same name instead of creating a new one.
updateBranch
string
default:"${{ github.ref_name }}"
Set the branch to update with environment configuration
directCommit
boolean
default:"false"
Direct Commit?When true, changes are committed directly to the branch. When false, a pull request is created.

Example Workflows

Create New Environment

jobs:
  create-env:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Create Development Environment
        uses: microsoft/AL-Go/Actions/[email protected]
        with:
          environmentName: 'Dev-${{ github.actor }}'
          adminCenterApiCredentials: ${{ secrets.ADMIN_CENTER_API_CREDENTIALS }}
          reUseExistingEnvironment: 'false'

Reuse Existing Environment

- name: Create or Reuse Development Environment
  uses: microsoft/AL-Go/Actions/[email protected]
  with:
    environmentName: 'SharedDevEnv'
    adminCenterApiCredentials: ${{ secrets.ADMIN_CENTER_API_CREDENTIALS }}
    reUseExistingEnvironment: 'true'
    updateBranch: 'main'
    directCommit: 'true'

Multi-Project Setup

- name: Create Environment for Specific Project
  uses: microsoft/AL-Go/Actions/[email protected]
  with:
    environmentName: 'Project1-Dev'
    project: 'Project1'
    adminCenterApiCredentials: ${{ secrets.ADMIN_CENTER_API_CREDENTIALS }}
The environment configuration will be committed to the repository, making it available for other developers and workflows.
Admin Center API credentials provide access to create and manage Business Central environments. Store them securely as GitHub secrets.

Build docs developers (and LLMs) love