Github Actions

GitHub Actions is a GitHub feature that enables you to automate various event-driven activities in GitHub, such as cloning a repository, generating Docker images, and testing scripts.

You can find over 10,000 GitHub Actions on the GitHub Marketplace or create your own Actions.

You can use the GitHub Action integration to integrate GitHub Actions with SEI.

For more information about supported integrations on SEI, go to What’s supported.

Requirements

You can either configure the integration using Github OAuth or use a Github Personal Access Token (PAT). In case you’re using the integration using a PAT ensure to Copy the token somewhere that you can retrieve it when you configure the integration. For instructions, go to Creating a personal API token on GitHub.

If you can't use OAuth, you must create a GitHub Personal Acess Token to configure the SEI GitHub integration.

  1. Log in to your GitHub account and create a Personal Access Token. For instructions, go to the GitHub documentation on Managing your personal access tokens.

  2. Select the following permissions for your Personal Access Token

    • All repo scopes, including the parent repo scope. The top-level repo scope is required for SEI to have the required visibility into your repos. (repoadmin:org -> read:org permission.)

    • If your GitHub organization uses SAML SSO, enable SSO for your Personal Access Token. For instructions, go to the GitHub documentation on Authorizing a personal access token for use with SAML SSO.

Note: The 'Triage Rule' and 'Trend' fields are not supported on the Stacks and Aggregation option for the Github Actions integration.

Configure the integration on the cloud

  1. Select Integrations under Settings.

  2. Select Available Integrations, locate the Github Actions integration.

  3. Select Install.

  4. Select an authentication method for the integration:

    • To use OAuth, select Authorize and follow the prompts to grant access to GitHub.

    • To use a personal access token, paste the token in Enter the Access Token.

  5. In Integration Name, enter a name for the integration.

  6. Select repositories to associate with the integration or select Ingest All Repos to associate all current and future repos in your GitHub organization.

  7. Select Finish and save the integration.

List of supported widgets:

Following widgets are supported for Github Action integration:

  • CICD Job Count Report

  • CICD Job Count Trend Report

  • CICD Job Duration Report

  • CICD Job Duration Single Stat

  • CICD Job Duration Trend Report

  • CICD Jobs Count Single Stat

  • CICD Pipeline Jobs Count Report

  • CICD Pipeline Jobs Count Trend Report

  • CICD Pipeline Jobs Duration Report

  • CICD Pipeline Jobs Duration Trend Report

  • Deployment Frequency - Dora widget

  • Change Failure Rate - Dora widget

Configure the integration using satellite

The steps for configuring the integration using satellite is similar to configuring the integration on cloud, with the exception of using satellite to communicate with the Github server.

Make sure to select the satellite integration checkbox while configuring the integration. If you experience any issues while configuring the integration using the Ingestion Satellite, refer to the Ingestion Satellite Troubleshooting and FAQs.

  1. In Integration Name, enter a Name for the integration.

  2. Add a Description for the integration. (Optional)

  3. In the URL field, add the URL where your GitHub repository is deployed. For example, if your GitHub is deployed on a virtual machine (VM), add the URL in the format: https://<IP_ADDRESS_OF_THE_VM_INSTANCE>

  4. Select Next and click on Download the Config file and save the satellite.yml file. Update it following the instructions here.

Here’s a sample satellite.yml file:

satellite:
  tenant: foo
  api_key: <SEI_API_KEY>
  url: 'https://staging.api.propelo.ai'
integrations:
  - id: '<INTEGRATION_ID>'
    application: github_actions
    url: 'https://<IP_ADDRESS_OF_THE_VM_INSTANCE>/'
    authentication: apikey

Ingest artifacts and environment variable data

This topic provides step-by-step instructions on how to set up a GitHub Actions workflow to allow SEI to ingest the data for the artifacts and environment variables from GitHub Actions.

What is needed

  • A GitHub repository for your project.

  • SEI Api Key & SEI Integration ID

  • Access to GitHub Actions in your repository.

  • Familiarity with environment variables and GitHub Actions configuration.

Set up the workflow

Follow these steps to set up the workflow:

  1. Create an SEI Api Key

    • Go to your SEI account and create an Api Key.

    • Give the Api Key a Name and Description.

    • Set the role as Ingestion.

  2. Create Organization/Repository Secret

    • To securely store the SEI Api Key, you can create a GitHub secret in either your organization or your repository, depending on your preference.

    • For Organization Secret, go to creating secrets in an organization Give the secret a name (e.g., `SEI_API_KEY`) and store the SEI Api Key value.

    • For Repository Secret, go to creating secrets in a repository Give the secret a name (e.g., `SEI_API_KEY`) and store the SEI Api Key value.

  3. Create the GitHub Actions Integration and make a note of the Integration ID, which you will need in the next steps. For more information, go to configure the integration on the cloud.

  4. Append the following steps to your existing GitHub Actions workflow configuration:

- name: Push artifacts to SEI Endpoint
  id: push_artifacts
  env:
    base_url: "https://api.propelo.ai" # Change the URL based on your environment (e.g., eu1, asia1, etc.)
    payload: '{"integration_id":"<INTEGRATION_ID>","repository":"${{ github.repository }}","job_run_number":"${{ github.run_number }}","job_name":"${{ github.workflow }}","artifacts":[{"name":"<ADD_IMAGE_NAME>", "location":"<ADD_LOCATION>", "tag":"<ADD_TAG>", "digest":"<ADD_DIGEST>","type":"<ADD_TYPE>", "artifact_created_at":"<ADD_ARTIFACT_CREATED_AT>"}]}'
  run: curl '${{ env.base_url }}/v1/cicd/push_artifacts' -H 'accept:application/json' -H 'authorization:Apikey ${{ secrets.SEI_API_KEY }}' -H 'content-type:application/json' --data-raw '${{ env.payload }}' --compressed --globoff

- name: Push params to SEI Endpoint
  id: push_params
  env:
    base_url: "https://api.propelo.ai" # Change the URL based on your environment (e.g., eu1, asia1, etc.)
    payload: '{"integration_id":"<INTEGRATION_ID>","repository":"${{ github.repository }}","job_run_number":"${{ github.run_number }}","job_name":"${{ github.workflow }}","params":[{"name":"<ADD_NAME>","type":"<ADD_TYPE>","value":"<ADD_VALUE>"}]}'
  run: curl '${{ env.base_url }}/v1/cicd/push_job_run_params' -H 'accept:application/json' -H 'authorization:Apikey ${{ secrets.SEI_API_KEY }}' -H 'content-type:application/json' --data-raw '${{ env.payload }}' --compressed --globoff

  1. Make sure to update the <INTEGRATION_ID> in the workflow step with your actual SEI Integration ID. Also, update the <BASE_URL> according to your environment:

  2. If there is an issue with the SEI endpoint (e.g. if the endpoint is down, 500 internal server error), and you want the workflow run to fail if artifacts are not sent to SEI, use the -f flag in the curl command. For example: For example: curl -f <REQUEST>

  3. Refer to the metadata below to request and ingest the artifact data from GitHub Actions into SEI.

Description

name

Image name of the artifact (e.g., ghcr.io/organization/repository:v0.1.1 where the repository is the image name)

location

Location of the artifact (e.g., ghcr.io/organization)

tag

Tag of the image (e.g., ghcr.io/organization/repository:v0.1.1 where v0.1.1 is the tag/qualifier).

digest

Digest/Hash of the generated artifact (e.g., sha256.).

type

Type of the generated artifact (optional). If CD is Harness, set type as "container" for correlation.

artifact_created_at

Creation time of the artifact in ISO format (optional, e.g., "2023-01-01T12:00:00.000+00:00").

  • name, location, tag, and digest of the artifact are required fields.

  • If type, artifact_created_at, or digest are not available you can remove those fields from the object.

  • type and artifact_created_at are optional fields.

  1. Refer to the metadata below to ingest the environment variables data from GHA into SEI. Note that all the keys mentioned are required fields.

KeysDescription

name

The environment variable name

type

The type of the environment variable (string/integer)

value

The associated value for the environment variable

Here's a sample Github Actions workflow:

name: Creating artifacts
run-name: ${{ github.actor }} is creating artifacts
on: 
    push:
        branches:
        - main
    workflow_dispatch:

jobs:
    check_env:
        runs-on: ubuntu-latest
        env:
            integration_id: 1
            sample: ${{ github.run_id }}
        steps:
            - name: Check artifacts
              run: echo 'Integration ID - ${{ env.integration_id }}'

    running-resuable-workflow:
        runs-on: ubuntu-latest
        env:
            check_run_id: 0
            modulo: 1
        steps:
            - name: Workflow Step 1
              run: echo 'Hello World';echo ${{ github.run_id }};echo ${{ env.modulo }}
            - name: Workflow Step 2 - If condition
              run: echo 'Exiting successfully'

    deploy-to-docker:
        runs-on: ubuntu-latest
        steps:
            - name: Configure Python in Ubuntu Environment
              run: |
                python3 -m pip install requests
                docker -v
            - uses: actions/checkout@v4
            - name: List files
              run: |
                pwd
                ls
            - name: Execute Python script
              run: |
                python3 sample_script.py
                ls /tmp/
              working-directory: ./temp/

            - name: Docker Login
              uses: docker/login-action@v1
              with:
                username: ${{ secrets.DOCKER_USERNAME }}
                password: ${{ secrets.DOCKER_PASSWORD }}
            - name: Build docker image
              run: |
               echo "Building image"
               docker system info | grep -E 'Username|Registry'
               docker build -t username/repo:tag .
              working-directory: ./temp/

            - name: Push Docker Image
              id: docker_deploy
              run: |
                docker push username/repo:tag
                echo "digest=$(docker inspect --format='{{index .RepoDigests 0}}' username/repo:tag | cut -d'@' -f2)" >> "$GITHUB_OUTPUT"   
              working-directory: ./temp/
            - name: Logout Docker
              run: |
                  echo "${{steps.docker_deploy.outputs.digest}}"
                  docker logout
        outputs:
            docker_digest: ${{ steps.docker_deploy.outputs.digest }}

    push_artifacts_to_sei:
        runs-on: ubuntu-latest
        needs: deploy-to-docker
        steps:
            - name: Push artifacts to SEI Endpoint
              id: push_artifacts
              env:
                base_url: "https://testapi1.propelo.ai" # change the URL based on environment e.g. eu1, asia1, etc.
                integration_id: 155
                docker_image: 'username/repo'
                tag: v1.18.0
                type: 'Test_repo2'
                payload: '{"integration_id":"155","repository":"${{ github.repository }}","job_run_number":"${{ github.run_number }}","job_name":"${{ github.workflow }}","artifacts":[{"name":"temp-test_rep01", "location":"registry.hub.docker.com/username", "tag":"v1.18.0", "type":"container", "digest": "${{needs.deploy-to-docker.outputs.docker_digest}}","artifacts_created_at": "2023-01-01T12:00:00.000+00:00"}]}'
              run: |
                curl '${{ env.base_url }}/v1/cicd/push_artifacts' -H 'accept:application/json' -H 'authorization:Apikey ${{ secrets.SEI_API_KEY }}' -H 'content-type:application/json' --data-raw '${{ env.payload }}' --compressed --globoff

            - name: Push params to SEI Endpoint
              id: push_params
              env:
                base_url: "https://testapi1.propelo.ai" # change the URL based on environment e.g. eu1, asia1, etc.
                payload: '{"integration_id":"155","repository":"${{ github.repository }}","job_run_number":"${{ github.run_number }}","job_name":"${{ github.workflow }}","params":[{"name":"docker_image","type":"string","value":"username/repo"}, {"name":"tag","type":"string","value":"v1.18.0"}, {"name":"artifacts_created_at","type":"string","value":"2023-01-01T12:00:00.000+00:00"}]}'
              run: curl '${{ env.base_url }}/v1/cicd/push_job_run_params' -H 'accept:application/json' -H 'authorization:Apikey ${{ secrets.SEI_API_KEY }}' -H 'content-type:application/json' --data-raw '${{ env.payload }}' --compressed --globoff

INFO

  • If the SEI API endpoint fails, the workflow will not be able to capture the artifacts or the job run parameters. In such cases, you will need to re-execute the Github Actions workflow.

  • Artifacts data from existing/previous workflow executions cannot be ingested into SEI.

  • Ensure that the tag names of images are unique to maintain the correct correlation between CI and CD processes.

PreviousGitHubNextGitLab Cloud

Last updated