Azure DevOps Bicep Tasks

This is a simple yet useful Azure DevOps set of tasks that allow to install and run Microsoft Bicep CLI commands in Azure Pipelines (cross-platform).

View in Marketplace

Install Bicep CLI task

This task downloads and installs in the agent any version of the Bicep CLI available (adding it to the PATH environment variable). After running the task, the Run Bicep CLI build command task can be used. Alternatively, bicep command could be used in a script directly.

The tool is cached in the agent after download, so subsequent runs will be faster.

This task takes only one version parameter input (semantic versioning) which is the version of Bicep to download.

Sample YAML with the task

steps:
- task: BicepInstall@0
  inputs:
    version: 0.10.13

Run Bicep CLI build command task

This tasks runs the bicep build command with an input path containing .bicep file(s) (glob is supported). After running the task, the resulting .json files are left in the same folder as the .bicep file resides.

This task takes only one sourceDirectory or sourceFile parameter input which is the path where the bicep file/files reside (can be a glob, directory, or a single file).

Note: When using a directory as sourceDirectory, all files included in the directory will be processed (including files in subfolders). Same behaviour as specifying the directory with the glob wildcard **. Example: ./bicep_files would be interpreted as ./bicep_files/**.

Sample YAML with the task (for multiple files)

steps:
- task: BicepBuild@0
  inputs:
    process: 'multiple'
    sourceDirectory: '.\bicep_files\*.bicep'
    stdout: false # Note if stdout is true 'outputDirectory' will not be interpreted
    outputDirectory: '.\bicep_files\out' # Only when 'stdout' is false or not defined

Sample YAML with the task (for single file)

steps:
- task: BicepBuild@0
  inputs:
    process: 'single'
    sourceFile: '.\bicep_files\sample1.bicep'
    stdout: false # Note if stdout is true 'outputDirectory' will not be interpreted
    outputFile: '.\bicep_files\sample1.out.json' # Only when 'stdout' is false or not defined and 'outputDirectory' is empty or not defined

Run Bicep CLI decompile command task

This tasks runs the bicep decompile command with an input path containing .json file(s) (glob is supported). After running the task, the resulting .bicep files are left in the same folder as the .json file resides.

This task takes only one sourceDirectory or sourceFile parameter input which is the path where the bicep file/files reside (can be a glob, directory, or a single file).

Note: Only files with .json extension will be processed.

Note: When using a directory as sourceDirectory, all files included in the directory will be processed (including files in subfolders). Same behaviour as specifying the directory with the glob wildcard **. Example: ./arm_templates would be interpreted as ./arm_templates/**.

Sample YAML with the task (for multiple files)

steps:
- task: BicepDecompile@0
  inputs:
    process: 'multiple'
    sourceDirectory: '.\arm_templates\*.json'
    stdout: false # Note if stdout is true 'outputDirectory' will not be interpreted
    outputDirectory: '.\arm_templates\out' # Only when 'stdout' is false or not defined

Sample YAML with the task (for single file)

steps:
- task: BicepDecompile@0
  inputs:
    process: 'single'
    sourceFile: '.\arm_templates\arm_storage_account.json'
    stdout: false # Note if stdout is true 'outputDirectory' will not be interpreted
    outputFile: '.\arm_templates\sample1.out.bicep' # Only when 'stdout' is false or not defined and 'outputDirectory' is empty or not defined

Important notes

Starting on version 0.3 of the tasks, the user can specify an outputProcess input to choose the output option. The available options are:

• default: Default (same name and directory as input files).
• outDir: Selecting an output directory with the input outputDirectory.
• outFile: Selecting an output file with the input outputFile.
• stdout: Standard output (stdout).

Nevertheless, this option can be skipped and only specify the inputs outputDirectory, outputFile, stdout accordingly. Note that the inputs are exclusive. Do not specify multiple output options at once.

The order of preference of the inputs if outputProcess is not defined is the following:

• stdout: if set to true.
• outputFile: if set.
• outputDirectory: if set.

If no input regarding output options is set, it will default to the source directory and source filename as output (only changing the extension).

Warnings handling

Starting with the patch 0.3.4, warnings in the build or decompilation processes will report a SucceededWithIssues status, showing all warnings in the pipeline execution.

Bicep versions support

Please consider using the latest version of the Bicep CLI, this extension does not ensure a correct execution with versions prior to 0.4.x.

Decompile command

Starting on version 0.3.7 of this extension, the decompile command will overwrite the destination file if it exists.

Local Development

Note: Bicep must be installed in the local machine. TypeScript must be also installed as a global package (npm i typescript -g).

1. Run npm install in the root directory.
2. Run npm run build in the root directory.
3. Define the needed agent environment parameters:

# For PowerShell:
$env:AGENT_TEMPDIRECTORY = "C:\TEMP" # Or any other existing directory
$env:AGENT_TOOLSDIRECTORY = "C:\tools" # Or any other existing directory

# For bash:
export AGENT_TEMPDIRECTORY="/temp" # Or any other existing directory
export AGENT_TOOLSDIRECTORY="/tools" # Or any other existing directory

4. (Optional) Set variables for the tasks (as you want to test):

# For PowerShell:
$env:INPUT_VERSION = "0.10.13" # Or any other valid Bicep version
$env:INPUT_PROCESS = "multiple" # Selection between 'multiple' or 'single' file(s) processing
$env:INPUT_SOURCEDIRECTORY = "C:\bicep_files\*.bicep" # Or any other existing directory with bicep file(s)
$env:INPUT_SOURCEFILE = "C:\bicep_files\sample1.bicep" # Or any other existing bicep file
$env:INPUT_STDOUT = $false # To print the output to standard output (stdout) or not
$env:INPUT_OUTPUTDIRECTORY = "C:\bicep_files\out" # Or any other existing directory to store the json generated file(s)
$env:INPUT_OUTPUTFILE = "C:\bicep_files\sample1.out.json" # Or any other path/filename to store the generated file

# For bash:
export INPUT_VERSION="0.10.13" # Or any other valid Bicep version
export INPUT_PROCESS = "multiple" # Selection between 'multiple' or 'single' file(s) processing
export INPUT_SOURCEDIRECTORY="C:\bicep_files\*.bicep" # Or any other existing directory with bicep file(s)
export INPUT_SOURCEFILE = "C:\bicep_files\sample1.bicep" # Or any other existing bicep file
export INPUT_STDOUT = false # To print the output to standard output (stdout) or not
export INPUT_OUTPUTDIRECTORY = "C:\bicep_files\out" # Or any other existing directory to store the json generated file(s)
export INPUT_OUTPUTFILE = "C:\bicep_files\sample1.out.json" # Or any other path/filename to store the generated file

5. Run node src/install/index.js and node src/run/index.js to execute the two tasks.

Note: the bicep_files and the arm_templates directories containing .bicep and .json files are only for development and testing purposes.

Contributing

Feel free to open an issue or a PR if you want to without any problem :)

License

This project is licensed under the MIT License.

See the LICENSE file in the root of this repository.

Attributions

The base logo for the tasks and the extension is property of the Microsoft Bicep project, used without any commercial purpose.