This repository provides a framework, guidleines and processes to author new and contribute to existing GitHub Actions deploying to Azure.
- Introduction to GitHub Actions for Azure
- Contributing to Azure Actions
GitHub Actions gives you the flexibility to build an automated software development lifecycle workflow.
With GitHub Actions for Azure you can create workflows that you can set up in your repository to build, test, package, release and deploy to Azure. Learn more about all other integrations with Azure.
Get started today with a free Azure account!
To easily create GitHub CI/CD workflows targeting Azure, use our Azure starter templates to deploy your apps created with popular languages and frameworks such as .NET, Node.js, Java, PHP, Ruby or Python, in containers or running on any operating system. Also the individual Action repos have a sample workflow included in their Readme file to help you quickly get started.
Please try out the GitHub Actions for Azure and share your feedback via Twitter on @Azure. If you encounter a problem, please open an issue on the GitHub repository for the specific action.
- Azure login(
azure/login) action can be used to authenticate to your Azure subscription using a service principal. - Azure CLI (
azure/cli) action sets up the GitHub Action runner environment with the latest (or any user-specified) version of the Azure CLI. - Azure PowerShell (
azure/PowerShell) action sets up the GitHub Action runner environment with the latest (or any user-specified) version of the Azure PowerShell module.
You can then run Azure CLI or Azure PowerShell scripts to create and manage any Azure resource.
Refer to starter templates for examples.
- ARM Deploy (
azure/arm-deploy) action can be used to deploy the ARM templates.This action can be used to deploy Azure Resource Manager templates at different deployment scopes - resource group deployment scope, subscription deployment scope and management group deployment scopes.
Refer to starter templates for examples.
With the Get KeyVault Secrets(azure/get-keyvault-secrets) action, you can fetch one or more secrets from an Azure keyvault instance and consume in your GitHub Action workflows.
Secrets fetched will be set as outputs of the keyvault action step and also as environment variables. All the variables are automatically masked if printed to the console or to logs.
Azure App Service is a managed platform for deploying and scaling web applications. You can easily deploy your web app to Azure App Service with
- Azure WebApp (
azure/webapps-deploy@v2)
Deploy a Static Web app using:
You could also configure App settings and Connection Strings using the actions:
- Azure App Service settings(
azure/appservice-settings). - Azure App Configuration Sync(
azure/appconfiguration-sync)
Learn more about deploying web applications to Azure using GitHub Actions from the documentation of respective actions and starter templates.
Streamline the deployment of your serverless applications to Azure Functions, an event-driven serverless compute platform, by using the below actions and starter templates.
- Azure Functions (
azure/functions-action) by bringing your code or - Azure Functions for containers(
azure/functions-container-action) by bringing your custom container image
For containerized apps (single- or multi-containers) to create a complete workflow
- use Docker login(
azure/docker-login) to build container images, push to a container registry (Docker Hub or Azure Container Registry) and then deploy the images to a Azure Web App or Azure Function for Containers, or to Kubernetes. - use Deploy to Azure Container Instances(
azure/aci-deploy) to deploy your container images to Azure Container Instances. - use Container scanning action(
azure/container-scan) to add additional checks to secure your Docker Images created as part of CI or PR workflows. This would help scan for any common vulnerabilities in the docker images and gain confidence before pushing them to a container registry or deploy them to a containerized web app or a Kubernetes cluster.
We have released multiple actions to help you connect to a Kubernetes cluster running on-premises or on any cloud, including Azure Kubernetes Service – AKS, bake and deploy manifests, substitute artifacts, check rollout status, and handle secrets within the cluster.
- Kubectl tool installer(
azure/setup-kubectl): Installs a specific version of kubectl on the runner. - Kubernetes set context(
azure/k8s-set-context): Used for setting the target Kubernetes cluster context which will be used by other actions or run any kubectl commands. - AKS set context(
azure/aks-set-context): Used for setting the target Azure Kubernetes Service cluster context . - Kubernetes create secret(
azure/k8s-create-secret): Create a generic secret or docker-registry secret in the Kubernetes cluster. - Kubernetes deploy(
azure/k8s-deploy): Use this to bake and deploy manifests to Kubernetes clusters. - Setup Helm(
azure/setup-helm): Install a specific version of Helm binary on the runner. - Kubernetes bake(
azure/k8s-bake): Use this action to bake manifest file to be used for deployments using helm2, kustomize or kompose. - Kubernetes lint(
azure/k8s-lint): Use this action to validate/lint your manifest files.
To deploy to a cluster on Azure Kubernetes Service, you could use azure/aks-set-context to communicate with the AKS cluster, and then use azure/k8s-create-secret to create a pull image secret and finally use the azure/k8s-deploy to deploy the manifest files.
Refer to starter templates for more examples.
- Build Azure Virtual Machine Images: Creates custom virtual machine images by injecting artifacts built in CI workflows as well as running custom installation scripts. Also easily shares images using Azure services like Shared Image Gallery.
We now have actions for database deployments
- Azure SQL database(
azure/sql-action) that uses a connection string for authentication and DACPAC/SQL scripts to deploy to your Azure SQL database. - Azure MySQL action(
azure/mysql) if you would like to deploy to an Azure MySQL database using MySQL scripts. - Azure Postgresql action(
azure/postgresql) if you would like to deploy to an Azure PostgreSQL database using PL/SQL scripts. Refer to starter templates for examples.
- Manage Azure Policy: You can now easily start on the journey of managing Azure policy from GitHub repository. All changes that are made to policy files in GitHub can be pushed to Azure Policy using this action in an orchestrated manner following safe deployment practices.
- Azure Policy Compliance Scan: With this action, you can now easily trigger a on demand scan from your GitHub workflow on one or multiple resources, resource groups or subscriptions, and continue/fail the workflow based on the compliance state of resources. You can also use this Github Action to generate a report on the compliance state of scanned resources for further analysis or archiving.
- Azure Machine Learning Login action to login / connect with Azure Machine Learning
- Azure Machine Learning Train action for training machine learning models using Azure Machine Learning
- Azure Machine Learning Deploy action deploys your model on Azure Machine Learning and creates a real-time endpoint for use in other systems. The endpoint can be hosted either on an Azure Container Instance or on an Azure Kubernetes Service.
Refer to starter templates for examples.
While GitHub Actions makes it easy to build, test, and deploy your code right from GitHub, you can also use it to trigger external CI/CD tools and services. For example, you could use GitHub Actions for Continuous Integration, and Azure Pipelines for Continuous Delivery to leverage features like Environments and deep integration with Kubernetes.
- Azure Pipelines(
azure/pipelines) action enables you to trigger an Azure Pipelines run as part of your Actions workflow.
Refer to starter templates for examples.
- variable substitution(
Microsoft/variable-substitution) action enables you to parameterize the values in JSON, XML or YAML files (including configuration files, manifests, etc) within a GitHub Action workflow.
Refer to starter templates for examples.
We will continue improving upon our available set of GitHub Actions, and will release new ones to cover more Azure services.
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.opensource.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., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.