https://github.com/josiahsiegel/azviz-action

Azure Visualizer for GitHub actions!
https://github.com/josiahsiegel/azviz-action

github-actions visualization

Last synced: 6 days ago
JSON representation

Azure Visualizer for GitHub actions!

• Host: GitHub
• URL: https://github.com/josiahsiegel/azviz-action
• Owner: JosiahSiegel
• Created: 2021-12-02T17:58:10.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-30T13:31:13.000Z (over 1 year ago)
• Last Synced: 2024-10-31T10:45:21.528Z (14 days ago)
• Topics: github-actions, visualization
• Language: PowerShell
• Homepage:
• Size: 21.5 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# AzViz (Azure Visualizer) action

![](https://badgen.net/badge/icon/gitguardian/green?icon=gitguardian&label)

[![Linux runner](https://github.com/JosiahSiegel/AzViz-action/actions/workflows/test_linux_runner.yml/badge.svg)](https://github.com/JosiahSiegel/AzViz-action/actions/workflows/test_linux_runner.yml)

[![Windows runner](https://github.com/JosiahSiegel/AzViz-action/actions/workflows/test_windows_runner.yml/badge.svg)](https://github.com/JosiahSiegel/AzViz-action/actions/workflows/test_windows_runner.yml)

## ☕ Please donate to [AzViz Developer](https://github.com/PrateekKumarSingh/AzViz#readme)

![](https://github.com/PrateekKumarSingh/AzViz/blob/master/img/themeneon.jpg)

## Synopsis

[AzViz](https://github.com/PrateekKumarSingh/AzViz) for [GitHub actions](https://github.com/marketplace?type=actions)!

## Inputs

### Required

```yml

inputs:

  resource-group:

    description: Comma-seperated resource group list

    required: true

  out-file:

    description: Graph export path

    required: true

    default: output/viz.svg

  sub-name:

    description: Azure subscription name

    required: true

    default: Pay-As-You-Go

```

### Optional

```yml

  theme:

    description: Graph theme (dark, light, neon)

    required: false

    default: neon

  depth:

    description: Level of Azure Resource Sub-category to be included in vizualization (1 or 2)

    required: false

    default: '1'

  verbosity:

    description: Level of information to included in vizualization (1 or 2)

    required: false

    default: '1'

  format:

    description: Graph format (png or svg)

    required: false

    default: svg

  direction:

    description: Direction in which resource groups are plotted on the visualization (left-to-right or top-to-bottom)

    required: false

    default: top-to-bottom

  exclude-types:

    description: Exclude resources via string search

    required: false

    default: '*excludethisthing1,excludethisthing2*'

  splines:

    description: Controls how edges appear in visualization. ('spline', 'polyline', 'curved', 'ortho', 'line')

    required: false

    default: spline

```

## Quick start

`sample_min_workflow.yml`

```yml

jobs:

  generate-viz:

      runs-on: ubuntu-latest

      steps:

        - name: Login to Azure

          uses: azure/login@v1

          with:

            creds: ${{ secrets.SERVICE_PRINCIPAL_CREDS }} 

            enable-AzPSSession: true

        - uses: JosiahSiegel/[email protected]

          with:

            resource-group: ${{ github.event.inputs.resource-group }}

            out-file: ${{ github.event.inputs.out-file }}

            sub-name: ${{ github.event.inputs.sub-name }}

        - uses: actions/upload-artifact@v2

          with:

            name: viz

            path: output/*

```

## Dependencies

 * [azure/login](https://github.com/marketplace/actions/azure-login) with `enable-AzPSSession: true`