Workflow CI Analytics Action

Github action that sends data around the ci job to big query

How it works

At the end of a workflow call this action to send ci analytics to big query

Usage

- uses: reside-eng/workflow-ci-analytics-action@v1
  with:
    # Google project ID where to send data
    #
    # Required: true
    project_id: ''

    # Bigquery dataset where to send data
    #
    # Required: true
    dataset: ''

    # Bigquery table where to send data
    #
    # Required: true
    table: ''

    # Timestamp when the job was created
    #
    # Required: true
    created_at: ''

    # Timestamp when the job was started
    #
    # Required: true
    started_at: ''

    # Timestamp when the job was completed
    #
    # Required: true
    completed_at: ''

    # matrix variable name (for parallel jobs only)
    matrix_name: ''

    # matrix variable value (for parallel jobs only)
    matrix_value: ''

    # The outcome status for the job
    #
    # Required: true
    result: ''

    # Is the running job triggered by a draft
    #
    # Default: false
    draft: ''

    # The url for the job
    job_link: ''

    # The triggering actor
    triggering_actor: ''

    # The run attempt number
    #
    # Required: true
    run_attempt: ''

    # The head ref
    head_ref: ''

    # The base ref
    base_ref: ''

    # The runner type
    #
    # Required: true
    runner_type: ''

    # The runner name
    #
    # Required: true
    runner_name: ''

Examples

Basic

name: Build

on:
  pull_request:
    branches:
      - main

jobs:
  build:
    name: build
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      # Your steps...

  notification:
    if: always()
    name: notification
    needs: [build]
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - uses: technote-space/workflow-conclusion-action@v2.0.1

      - uses: reside-eng/workflow-ci-analytics-action@v1
        with:
          created_at: timestamp
          started_at: timestamp
          completed_at: timestamp
          matrix_name: string
          matrix_value: string
          result: string
          draft: false
          job_link: string
          github-token: ${{ secrets.GITHUB_TOKEN }}

Local development

Please install gh CLI: https://github.com/cli/cli#installation

In order to run the tests, you'll need to configure authentication using your gh CLI:

gh auth refresh

You'll be prompted with a one-time code, copy this one. Then click on enter, a web page will open in your browser. Paste the code previously copied. Click on Authorize github You're all set !

License

The scripts and documentation in this project are released under the MIT License.