usage-examples.md

Usage examples

This document contains minimal usage examples for the reusable workflows in this repository.

Provision Azure resources using Terraform

Prerequisites:

• Configure OIDC authentication from GitHub Actions to Azure
• Configure Terraform backend
• Configure GitHub secret ENCRYPTION_PASSWORD with a randomly generated password (used to encrypt the uploaded artifact, as it may contain sensitive infrastructure configuration)

on:
  push:
    branches: [main]

jobs:
  provision:
    uses: equinor/ops-actions/.github/workflows/terraform.yml@main
    with:
      terraform_version: latest
      working_directory: "."
      environment: development
    secrets:
      AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
      AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
      ENCRYPTION_PASSWORD: ${{ secrets.ENCRYPTION_PASSWORD }}

Supported Terraform providers:

Name	Source	Version
Azure	hashicorp/azurerm	>= v3.20.0
AzAPI	azure/azapi	>= v1.3.0

Deploy Docker image to Azure Web App

Prerequisites:

• Configure OIDC authentication from GitHub Actions to Azure

on:
  push:
    branches: [main]

jobs:
  build:
    uses: equinor/ops-actions/.github/workflows/docker-acr@main
    with:
      working_directory: "."
      registry_name: crexampledev
    secrets:
      AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
      AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}

  deploy:
    needs: build
    uses: equinor/ops-actions/.github/workflows/azure-webapp.yml@main
    with:
      environment: development
      image: ${{ needs.build.outputs.image }}
      app_name: app-example-dev
    secrets:
      AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
      AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}

Deploy Python application to Azure Function App

Prerequisites:

• Configure OIDC authentication from GitHub Actions to Azure

on:
  push:
    branches: [main]

jobs:
  build:
    uses: equinor/ops-actions/.github/workflows/python.yml@main
    with:
      python_version: latest
      working_directory: "."
      requirements: requirements.txt
      pip_install_target: .python_packages/lib/site-packages # Required

  deploy:
    needs: build
    uses: equinor/ops-actions/.github/workflows/azure-function.yml@main
    with:
      environment: development
      artifact_name: ${{ needs.build.outputs.artifact_name }}
      app_name: func-example-dev
    secrets:
      AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
      AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}

Deploy Python application to Azure Web App

Prerequisites:

• Configure OIDC authentication from GitHub Actions to Azure

on:
  push:
    branches: [main]

jobs:
  build:
    uses: equinor/ops-actions/.github/workflows/python.yml@main
    with:
      python_version: latest
      working_directory: "."
      venv_path: antenv # Required
      requirements: requirements.txt
      pip_install_target: .python_packages/lib/site-packages # Required

  deploy:
    needs: build
    uses: equinor/ops-actions/.github/workflows/azure-webapp.yml@main
    with:
      environment: development
      artifact_name: ${{ needs.build.outputs.artifact_name }}
      app_name: app-example-dev
    secrets:
      AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
      AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}

Deploy .NET application to Azure Web App

Prerequisites:

• Configure OIDC authentication from GitHub Actions to Azure

on:
  push:
    branches: [main]

jobs:
  build:
    uses: equinor/ops-actions/.github/workflows/dotnet.yml@main
    with:
      dotnet_version: "9.x"
      project: Source/ExampleApp/ExampleApp.csproj

  deploy:
    needs: build
    uses: equinor/ops-actions/.github/workflows/azure-webapp.yml@main
    with:
      environment: development
      artifact_name: ${{ needs.build.outputs.artifact_name }}
      app_name: app-example-dev
    secrets:
      AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
      AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}

Deploy MkDocs site to GitHub Pages

on:
  push:
    branches: [main]
    paths:
      - docs/**
      - mkdocs.yml

jobs:
  build:
    uses: equinor/ops-actions/.github/workflows/mkdocs.yml@main
    with:
      python_version: latest
      mkdocs_version: ">=1.0.0"

  deploy:
    needs: build
    uses: equinor/ops-actions/.github/workflows/github-pages.yml@main
    with:
      artifact_name: ${{ needs.build.outputs.artifact_name }}

Update Databricks Git folder

Prerequisites:

• Configure OIDC authentication from GitHub Actions to Azure
• Create Git folder /Repos/<GITHUB_REPOSITORY> in the target Databricks workspace and add the service principal with access Can Manage

on:
  push:
    branches: [main]

jobs:
  update:
    uses: equinor/ops-actions/.github/workflows/databricks-repos.yml@main
    with:
      environment: development
      cli_version: "" # empty == latest
      databricks_host: https://adb-709200391298940.4.azuredatabricks.net
    secrets:
      AZURE_CLIENT_ID: ${{ secrets.AZURE_CLIENT_ID }}
      AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
      AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}