Findy Team+ CI Analytics Action

A GitHub Action that sends CI workflow execution results to Findy Team+ for development performance analytics.

日本語版 README はこちら

Usage

Basic

Add the following job to your existing workflow:

name: CI

on:
  push:
    branches: [main]
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Build
        run: echo "build"

  ci-report:
    runs-on: ubuntu-slim
    if: always()
    needs: [build]
    permissions:
      actions: read
    steps:
      # Pin to a specific commit SHA for supply chain security.
      # Find the SHA for each release at:
      # https://github.com/Findy/team-plus-cicd-analytics/releases
      - uses: Findy/team-plus-cicd-analytics@<COMMIT_SHA> # v1.0.0
        with:
          organization-id: ${{ secrets.TEAM_PLUS_ORGANIZATION_ID }}
          api-token: ${{ secrets.TEAM_PLUS_WEBAPI_TOKEN }}
          status: ${{ needs.build.result }}
          github-token: ${{ github.token }}

Multi-job workflow

To report combined results from multiple jobs:

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm test

  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm run lint

  ci-report:
    runs-on: ubuntu-slim
    if: always()
    needs: [test, lint]
    permissions:
      actions: read
    steps:
      # Pin to a specific commit SHA for supply chain security.
      # Find the SHA for each release at:
      # https://github.com/Findy/team-plus-cicd-analytics/releases
      - uses: Findy/team-plus-cicd-analytics@<COMMIT_SHA> # v1.0.0
        with:
          organization-id: ${{ secrets.TEAM_PLUS_ORGANIZATION_ID }}
          api-token: ${{ secrets.TEAM_PLUS_WEBAPI_TOKEN }}
          status: ${{ (contains(needs.*.result, 'failure') && 'failure') || (contains(needs.*.result, 'cancelled') && 'cancelled') || 'success' }}
          github-token: ${{ github.token }}

Inputs

Parameter	Description	Required	Default
organization-id	Findy Team+ organization ID	Yes	-
api-token	Findy Team+ API token	Yes	-
status	Workflow execution result (success, failure, cancelled)	Yes	-
github-token	GitHub token for fetching workflow run data	Yes	-
include-jobs	Whether to include job-level detail data	No	true
job-timeout	Timeout in seconds for fetching job data	No	5

Setup

1. Get an API token from Findy Team+

Follow the Findy Team+ CI Analytics documentation to obtain your organization ID and API token.

2. Register GitHub Secrets

Go to your repository's Settings > Secrets and variables > Actions and add:

• TEAM_PLUS_ORGANIZATION_ID — Your Findy Team+ organization ID
• TEAM_PLUS_WEBAPI_TOKEN — Your Findy Team+ API token

3. Add to your workflow

Add a ci-report job to your workflow using the examples above.

Important: Always set if: always() on the report job so results are sent even when preceding jobs fail.

Required permissions

This Action requires the following permissions:

permissions:
  actions: read  # Read workflow run data

When using the default ${{ github.token }} for github-token, these permissions are granted automatically.

Data sent

Workflow data

Field	Description
organization_name	Findy Team+ organization ID
schema_version	Payload schema version (currently 2)
repo_name	Repository name (owner/repo format)
workflow_name	Workflow name
run_id	Workflow run ID
url	Workflow run URL
status	Execution result status
start_at	Workflow start time
end_at	Workflow end time
jobs	Array of job detail data (when include-jobs: true)

Job data (optional)

When include-jobs: true (default), the following data is included for each completed job:

Field	Description
name	Job name
status	Job status (success, failure, cancelled, skipped)
start_at	Job start time
end_at	Job end time
job_id	GitHub job ID (jobs API .id)
run_attempt	Job run attempt number
runner_id	Runner ID (null if unavailable)
runner_name	Runner name (null if unavailable)
runner_group_id	Runner group ID (null if unavailable)
runner_group_name	Runner group name (null if unavailable)
labels	Labels the job requested (equivalent to runs-on; null if unavailable)

Note: The currently running report job itself is excluded. Only completed jobs are sent. Runner fields (runner_id / runner_name / runner_group_id / runner_group_name) may be null when the runner information is not exposed by the GitHub API (e.g. skipped jobs). labels is normally returned as an array (possibly empty), but may be null if the field is absent from the API response.

Contributing

Bug reports and feature requests are welcome via Issues. Pull requests are also welcome!

License

Apache License 2.0 — see LICENSE for details.