Blog

GitHub Integration

~5 minutes read

Overview

This guide will help you seamlessly connect your GitHub projects with Binadox. Whether you’re a developer, project manager, or DevOps professional, this integration will provide valuable data and tools to optimize your software development lifecycle. Follow this step-by-step guide to set up the integration quickly and efficiently.

Once integrated, pricing will be automatically calculated after each push to the repository and added as a comment to the commit. Ensure that your account has the necessary permissions to write comments. If permissions are not granted, comments will appear every 24 hours. While this step is optional, it’s highly recommended for immediate feedback.

Integration Steps

1. Generate a Secret Token in Binadox

Navigate to System Configuration > API. Click the Create API button.

Enter a descriptive name for your API token in the Name field. Click Save.

Copy and securely store the generated API key. You’ll need this in step 3.

2. Create a New Configuration File in GitHub

In the root directory of your GitHub project, create a new file named .github/workflows/binadox.yml.

Enter the following code in the file:

on: [push]
jobs:
  binadox_job:
    runs-on: ubuntu-latest
    name: Binadox Structure-As-Code Analyzer
    steps:
      - name: binadox
        uses: binadox-public/binadox-infrastructure-as-code-analyzer@v1.2
        with:
          binadox-secret-token: '${{ secrets.BINADOX_TOKEN }}'
          binadox-server-url: 'https://app.binadox.com/api/1/organizations/pricing/callback/analyze_iaac'
          binadox-project-name: 'my project'
      - name: Get the status
        run: echo "Status ${{ steps.binadox.outputs.status }}"

Click the Commit changes button.

3. Create GitHub Secrets and Variables

Go to your GitHub repository’s Settings.

In the left sidebar menu, select Secrets and variables, then click on Actions.

Click on the New repository secret button.

Create a new secret.

Name: BINADOX_TOKEN
Secret: [Your Binadox API key from step 1]

Note:

Always keep your BINADOX_SECRET_TOKEN secure. Never expose it in your code or public repositories.

Click on the Variables section and click New repository variable.

Add the following variables:

BINADOX_SERVER_URL: https://prod.binadox.com/api/1/organizations/pricing/callback/analyze_iaac
BINADOX_PROJECT_NAME: Your project name (e.g., “my project”)

Support and Resources

For further assistance, please contact Binadox support.
Consult the GitHub Actions documentation for more information on workflow configuration.
Visit the Help Center for additional details on the Structure-As-Code Analyzer.

By following this guide, you’ve successfully integrated the Binadox Structure-As-Code Analyzer with your GitHub repository, enabling automated code analysis to enhance your development workflow and code quality.

Go Up

Blog

GitHub Integration

GitHub Integration

~5 minutes read

This guide provides information on how to integrate GitHub, a web-based hosting service for software development projects, with the cloud and SaaS cost optimization platform Binadox to be able to receive GitHub spending and utilization insights, cost optimization recommendations and individual user data across an entire organization.

1. Generate a New Personal Access Token

To connect GitHub to Binadox, generate a new personal access token and specify token access permissions.

1. Log in to GitHub with an administrator account.

2. Click on the profile settings at the top right corner of the menu bar. Select Settings in the drop-down list.

3. In the navigation pane on the left, click Developer settings.

4. In the navigation pane on the left, click Personal access tokens. Click the Generate new token button at the top.

5. In the New personal access token view, specify the purpose of a new token in the Note field for further differentiation (e.g. Binadox). In the Select scopes list, define the access for a new token.

IMPORTANT:
To ensure proper Binadox analysis of GitHub usage and costs, make sure to select the following checkboxes:
– read:org
– read:user
– user:email
– read:enterprise

Click Generate token.

6. Copy the personal access token and keep it safe. You won’t be able to see it again.

2. Create New Connection for GitHub in Binadox

1. Log into your Binadox account.

2. In the navigation pane on the left, click SaaS Connections. Click on the GitHub icon. To quickly locate the GitHub software in the list of supported applications, type in its name in the search bar.

3. Indicate a connection name. Click Continue.

4. Fill in the connection properties. Enter a personal access token into the Personal Access Token field (see Clause 1 on how to generate a personal access token). Indicate a GitHub organization in the Business Name field. Click Continue.

NOTE:
Data for usage monitoring and spend optimization is collected for the organization specified during configuration. If you manage more than one GitHub organization in your account, create an instance for each of them to get aggregate data.

To see the list of organizations in a GitHub account, click on the profile settings at the top right corner of the menu bar. Select Settings and go to Organizations on the navigation pane.

5. Fill in the billing information. Click on the calendar icon to specify the date the bill for application services is issued. Select a payment plan and a billing period in the corresponding drop-down lists. Click Connect.

GitHub is successfully integrated with Binadox.

Go Up