https://github.com/azure/bicep-build-action

GitHub Action for building an ARM Template from Bicep
https://github.com/azure/bicep-build-action

arm-templates azure bicep github-actions

Last synced: 6 days ago
JSON representation

GitHub Action for building an ARM Template from Bicep

• Host: GitHub
• URL: https://github.com/azure/bicep-build-action
• Owner: Azure
• License: mit
• Created: 2021-09-15T19:59:29.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-18T18:00:58.000Z (over 2 years ago)
• Last Synced: 2025-01-30T13:51:11.614Z (12 days ago)
• Topics: arm-templates, azure, bicep, github-actions
• Homepage:
• Size: 13.7 KB
• Stars: 13
• Watchers: 5
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# 💪 Bicep Build Action [![Build](https://github.com/Azure/bicep-build-action/actions/workflows/ci.yml/badge.svg)](https://github.com/Azure/bicep-build-action/actions/workflows/ci.yml)

GitHub Action that builds a [Bicep](https://docs.microsoft.com/EN-US/azure/azure-resource-manager/bicep/overview) main file and outputs a generated ARM Template file.

## When to use

The action is particularly useful for Continuous Integration scenarios where you want to validate the ARM template further on your workflow and/or publish it as an artifact.

## Getting Started

### Prerequisites

If your GitHub Actions workflows are running on a [self-hosted runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners):

- [Azure CLI](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/install#azure-cli) 2.20.0 or later installed

- File write permission on the runner as this action creates an ARM template file dynamically.

### Usage

```yml

steps:

  - name: Bicep Build

    uses: Azure/[email protected]

    with:

      bicepFilePath: main.bicep

      outputFilePath: azuredeploy.json

```

### Inputs

| Name | Description | Required | Default value |

| --- | --- | --- | --- |

| `bicepFilePath` | Bicep main file path | false | `./main.bicep` |

| `outputFilePath` | Path where the ARM template file will be created | false | `./azuredeploy.json` |  ARM |

# Contributing

This project welcomes contributions and suggestions. Most contributions require you to

agree to a Contributor License Agreement (CLA) declaring that you have the right to,

and actually do, grant us the rights to use your contribution. For details, visit

https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need

to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the

instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)

or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.