Skip to main content
Skip table of contents

GitHub

GitHub is a software development platform that allows developers to create, store, manage, and share their code. This guide explains how to add GitHub integration to Cloudaware.

GitHub - CA_logo_black copy.png To see how Cloudaware seamlessly integrates with GitHub in action, request a demo.

Create a GitHub token

Cloudaware collects repositories accessible to the authenticated user as a member of the organization.

Generate a user token in GitHub:

  1. Log in to GitHub. Under the user icon, select Settings.

  2. Go to Developer settings → Personal Access Tokens. Select the token type.

  3. Click Generate new token. Set a name, description, and expiration period (recommended: at least 1 year).

  4. Click Add permissions and select the following:

    • For fine-grained access tokens:

      • Actions

      • Codespaces

      • Contents

      • Dependabot alerts

      • Environments

      • Issues

      • Pull requests

      • Secrets*

      • Webhooks

      • Workflows

    • For tokens (classic):

      • repo (full access for private repositories) or public_repo (public repos only)

      • workflow

      • read:packages

      • read:org

      • read:repo_hook

      • admin:org_hook

      • codespace

      • read:project

  5. Click Generate token.

*Clodaware collects only metadata of secrets.

Add a GitHub account

  1. Log in to Cloudaware → Admin.

    GitHub - admin.png

  2. Find GitHub Accounts in integrations. Click +ADD.

    GitHub - admin - add integration.png

  3. Fill out the form:

    GitHub - integration details.png

    WHERE
    Name – a name for the GitHub integration
    Token – the GitHub token

    Click CHECK to test the connection. Once the validation passed, click SAVE.

  4. A green light in the ‘Status’ column indicates successful configuration. If the light is red, contact support@cloudaware.com.

    GitHub - integration status.png

  5. To view GitHub-related data, go to Cloudaware CMDB Navigator. Select GITHUB in the left-hand menu.

    GitHub - GitHub objects in CMDB.png

List of GitHub objects

Cloudaware supports the following GitHub objects:

  • GitHub Account CA10GH__CaGithubAccount__c

  • GitHub Branch CA10GH__CaGithubBranch__c

  • GitHub Codespace CA10GH__CaGithubCodespace__c

  • GitHub Dependabot Alert CA10GH__CaGithubDependabotAlert__c

  • GitHub Environment CA10GH__CaGithubEnvironment__c

  • GitHub Issue CA10GH__CaGithubIssue__c

  • GitHub Organization CA10GH__CaGithubOrganization__c

  • GitHub Package CA10GH__CaGithubPackage__c

  • GitHub Project CA10GH__CaGithubProject__c

  • GitHub Pull Request CA10GH__CaGithubPullRequest__c

  • GitHub Repository CA10GH__CaGithubRepository__c

  • GitHub Secret CA10GH__CaGithubSecret__c (metadata)

  • GitHub Team CA10GH__CaGithubTeam__c

  • GitHub User CA10GH__CaGithubUser__c

  • GitHub Webhook CA10GH__CaGithubWebhook__c

  • GitHub Workflow CA10GH__CaGithubWorkflow__c

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.