Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
activity

GitHub Action

actions-timeline

v0.2.1

actions-timeline

activity

actions-timeline

An Action shows timeline of a GitHub Action workflow in the run summary page

Installation

Copy and paste the following snippet into your .yml file.

              

- name: actions-timeline

uses: Kesin11/actions-timeline@v0.2.1

Learn more about this action in Kesin11/actions-timeline

Choose a version

actions-timeline

An Action shows timeline of a GitHub Action workflow in the run summary page.

actions-timeline is a tool that allows developers to visualize the sequence of jobs and steps that occur during a GitHub Actions workflow. By examining the timeline, you can quickly identify any issues or bottlenecks in your workflow, and make adjustments as needed to improve performance and efficiency.

Sample screenshot

USAGE

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    # Register this action before your build step. It will then be executed at the end of the job post-processing.
    - uses: Kesin11/actions-timeline@v0
      with:
        # e.g.: ${{ secrets.MY_PAT }}
        # Default: ${{ github.token }}
        github-token: ''

    # Your build steps...

If your workflow has many jobs, you should run actions-timeline in the job that takes the most time, or create an independent job for actions-timeline in a last of the workflow.

jobs:
  build-1:
  build-2:
  build-3:
  
  action-timeline:
    needs: [build-1, build-2, build-3]
    runs-on: ubuntu-latest
    steps:
    - uses: Kesin11/actions-timeline@v0

How it works

actions-timeline fetches the jobs and steps of the workflow run from the GitHub API, and then generates a timeline with mermaid gantt diagrams. Thanks to the GitHub flavored markdown that can visualize mermaid diagrams, the timeline is displayed in the run summary page.

This action is run on post-processing of the job, so you should register this action before your build step. If you register this action after your build step, the timeline will not include other post-processing steps.

Support GHES

You can set GITHUB_API_URL environment variable to use this action with GHES.

- uses: Kesin11/actions-timeline@v0
  env:
    GITHUB_API_URL: 'https://github.example.com/api/v3'

DEVELOPMENT

Setup

deno task setup:githooks

DEBUG

If you want to debug this action, first generate dist/ then execute own action.

- uses: actions/checkout@v3
- uses: denoland/setup-deno@v1
- run: deno task bundle
- uses: ./

LICENSE

MIT