Skip to content

cilium/workflow-telemetry-action

 
 

Repository files navigation

workflow-telemetry-action

A GitHub Action to track and monitor the workflow runs, jobs and steps of your GitHub Action workflow runs. This fork receives minimal maintenance from Cilium committers.

Example Output

An example output of a simple workflow run will look like this.

Step Trace Example

Usage

To use the action, add the following step before the steps you want to track.

permissions:
  pull-requests: write
jobs:
  workflow-telemetry-action:
    runs-on: ubuntu-latest
    steps:
      - name: Collect Workflow Telemetry
        uses: cilium/workflow-telemetry-action@v2

Configuration

Option Requirement Description
github_token Optional An alternative GitHub token, other than the default provided by GitHub Actions runner.
comment_on_pr Optional Set to true to publish the results as comment to the PR (applicable if workflow run is triggered by PR). Defaults to true.
Requires pull-requests: write permission
job_summary Optional Set to true to publish the results as part of the job summary page of the workflow run. Defaults to true.
theme Optional Set to dark to generate charts compatible with Github dark mode. Defaults to light.

About

Github action to collect metrics (job, step completion time) from your workflows to help you debug and optimize your CI/CD pipeline

Resources

License

Stars

Watchers

Forks

Contributors

Languages

  • TypeScript 93.8%
  • Shell 6.2%