The Build Reference Documentation action generates comprehensive reference documentation for your Business Central AL applications using the ALDoc tool. It processes built artifacts to create documentation that can be published to GitHub Pages or other documentation platforms.
Usage
shell
string
default:"powershell"
Shell in which you want to run the action (powershell or pwsh)
token
string
default:"${{ github.token }}"
The GitHub token running the action
The artifacts to build documentation for or a folder in which the artifacts have been downloadedThis should point to a folder containing compiled Business Central app files (.app).
The URL of the BC artifact to download which includes AlDocIf not specified, the action will use the default Business Central artifact that includes the ALDoc tool.
Example Workflows
Basic Documentation Generation
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Download build artifacts
uses: actions/download-artifact@v4
with:
name: build-artifacts
path: .artifacts
- name: Build Reference Documentation
uses: microsoft/AL-Go/Actions/[email protected]
with:
artifacts: '.artifacts'
With Custom BC Artifact
- name: Build Reference Documentation
uses: microsoft/AL-Go/Actions/[email protected]
with:
artifacts: '.artifacts'
artifactUrl: 'https://bcartifacts.azureedge.net/onprem/24.0.16410.17763/w1'
Generate and Deploy to GitHub Pages
jobs:
build-and-deploy-docs:
runs-on: ubuntu-latest
permissions:
contents: read
pages: write
id-token: write
steps:
- uses: actions/checkout@v4
- name: Download artifacts
uses: actions/download-artifact@v4
with:
name: build-artifacts
path: .artifacts
- name: Build Reference Documentation
uses: microsoft/AL-Go/Actions/[email protected]
with:
artifacts: '.artifacts'
- name: Upload to GitHub Pages
uses: actions/upload-pages-artifact@v3
with:
path: '.aldoc'
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
The generated documentation is typically placed in the .aldoc folder and includes HTML files with detailed API references for your AL objects.
Ensure your artifacts folder contains valid compiled Business Central app files (.app) before running this action.