GitHub Action
hava-sync-action
Github action for integrating Hava with your github pipelines, allowing you to automatically synchronize and export a diagram after you have deployed changes to your environment
Hava provides a single view across all you cloud environments, which allows you to quickly understand and diagnose issues. It provides a view of all your resources and automatically generate architecture diagrams for your environments. Automating away the tedious task of keeping documentation up to date.
See https://www.hava.io for more details
To use the action in your own repository, include it as a step in your job
- uses: teamhava/hava-sync-action@v1
with:
source_id:
hava_token:
environment_id:
view_type:
An example of this action in use can be found in our example repo
At times you don't need to generate a new image, you only want to synchronize the latest changes to Hava. To support that you can set the skip_export
variable to true. In these cases you will not need to set the environment_id
or view_type
variables.
- uses: teamhava/hava-sync-action@v1
with:
source_id:
hava_token:
skip_export: true
Input | Description | Required | Default |
---|---|---|---|
source_id | ID of the Hava source to synchronize | y | |
hava_token | API token to access Hava API | y | |
environment_id | ID of the Hava environment to generate png archicture diagram from. (Optional if skip_export is true) |
n | |
view_type | Type of view to generate a png diagram for. Supported values: infrastructure, container, security. (Optional if skip_export is true) |
n | |
image_path | Path to export png image to | n | docs/architecture.png |
skip_export | Allows you to skip exports if you don't require the generated diagram | n | false |
Output | Description |
---|---|
path | Path to the exported image file in the repo |