LogoLogo
HomePricingSelf-hosted docsAPI docsLogin
  • Home
  • Login to hava
  • Developer
  • Getting Started
    • Quickstart
      • Create New Account
      • Import Demo Data
      • Creating Environments
      • Exporting Diagrams
  • AWS Marketplace
  • Using Hava
    • Providers & Sources
    • Environments
      • Creating Environments
      • Filtering Environments
  • Importing Data
    • Demo Data
    • AWS
      • Getting Started with AWS
        • Cross Account Role
        • Read Only IAM User
        • Minimum Access IAM User
      • AWS Supported Resources
      • AWS Views
        • Infrastructure
        • Security
        • Container - ECS
        • List
    • Azure
      • Getting Started with Azure
        • Powershell
        • Azure Portal
      • Azure Supported Resources
      • Azure Views
        • Infrastructure
        • Azure Security View
        • List
    • Google Cloud
      • Getting Started with GCP
        • Service Account
        • Import Multiple Projects
        • Enabling APIs
      • GCP Supported Resources
      • GCP Views
        • Infrastructure
        • List
    • Kubernetes
      • Getting Started with Kubernetes
        • Read Only Kubeconfig
        • Automatic Import of Managed Kubernetes
          • AWS EKS Cluster Configuration
        • Converting certificate files to certificate data fields
      • Kubernetes Supported Resources
      • Kubernetes Views
        • Container
        • List
    • Import Errors
  • Discover
    • Importing
    • Searching
      • Search Overview
      • Search Syntax
        • VPC Search
        • Wildcard Search
        • Tag Search
        • Deep Search
      • Search Examples
        • Discover Resources From Regions
        • Create a multiple VPC diagram
        • Defining Custom Environments
    • Versioning
      • Tracking Changes in Cloud Architecture
    • Manual Sync
  • Diagram
    • Listing Environments
      • Filtering Environments
      • Favouriting Environments
    • Viewing Environments
      • Diagram Controls
      • Diagram Layout
      • Switch Between Views
      • Diagram Canvas Resource Filters
    • Draw Custom Connections
  • Diagnose
    • Architectural Monitoring Alerts
    • Attributes
    • Cost Estimation
    • Diff View - Comparing Diagrams
    • Infrastructure
      • View Route Tables
      • View ACLs
      • View Security Groups
    • Reports
      • AWS Compliance Reports
  • Document
    • Environment Notes
    • Embed
    • Exporting Diagrams
    • Edit
      • Draw.io
  • Collaboration
    • Teams
    • Inviting Users
    • Disabling users
    • SSO/SAML
      • Overview
      • Azure AD - SAML Setup
      • Azure AD - OIDC Setup
      • Okta - SAML Setup
      • Okta - OIDC Setup
      • Trouble Shooting SSO
    • Project folders
  • Integrations
    • AWS Control Tower
    • CLI
    • Confluence Cloud
    • GitHub
    • Terraform
  • API
    • API Docs
  • Account & Billing
    • Types Of Hava Accounts
    • Change Subscription
    • Switch to AWS marketplace
    • Change Password
    • MFA
    • Download Invoice
    • Cancel Account
    • Account Audit Log
  • Quick Look
    • Quick AWS Overview
    • Security Overview
    • Customize the Hava Dashboard
Powered by GitBook
On this page
  • Usage
  • Getting Configuration Values
  • Hava API Token
  • Source ID
  • Environment ID

Was this helpful?

  1. Integrations

GitHub

Integrating Hava with GitHub using Actions

PreviousConfluence CloudNextTerraform

Last updated 1 year ago

Was this helpful?

Hava has published an Action to make it easier to integrate Hava with a CI/CD pipeline. It allows you trigger a synchronization of one of your sources as part of your workflow execution, and optionally export a PNG image of the updated environment that can be committed to your documents folder to keep it up to date and in sync with your code changes.

The latest version of hava-sync-action can be found on the .

Usage

To use the action as part of your workflow, you need to create a step in your job like below

jobs:
  sync:
    runs-on: ubuntu-latest

    steps:
      - uses: teamhava/hava-sync-action@v1
        with:
          source_id: ${{ secrets.HAVA_SOURCE_ID }}
          hava_token: ${{ secrets.HAVA_API_TOKEN }}
          environment_id: ${{ secrets.HAVA_ENV_ID }}
          view_type: "infrastructure"

This is a minimal setup for the action, details on all the settings can be found in the and our .

You can also see an implementation of the action in our .

Getting Configuration Values

The action requires a few configuration values that you need to know before you implement this in your own repository: The ID of the source you are synchronizing, the ID of the environment you are exporting an image of, and a token to access the Hava API

Hava API Token

Source ID

There are two main ways to get the ID of a source, you can either use the API to get a list of all sources and their ID, or you can use the search bar in the Hava app

Using the API

Using the App UI

When you search using the source: key in the Hava application it will list all the available options for you like in the below screenshot. Select the source you are looking for and the ID will be added to the search query. You can now copy this and use it in your workflow

Environment ID

The environment ID is available as part of the URL when you click on an environment in the Hava application. Copy the the portion of the URL that is highlighted below, it's a UUID.

To generate a new API token, follow the guide in our .

The Hava API has a /source endpoint that can be accessed on https://api.hava.io/sources to get the list. See our for more detail

GitHub marketplace
marketplace listing
public github repository
public example repository
developer documentation
API documentation
Source search auto complete
Example of the environment ID in the URL