https://github.com/urcomputeringpal/workflow-run-history

Adds an Actions "job summary" explaining the historical performance and success rate of the calling Actions Workflow over the previous month
https://github.com/urcomputeringpal/workflow-run-history

actions github-actions performance reliability

Last synced: 10 days ago
JSON representation

Adds an Actions "job summary" explaining the historical performance and success rate of the calling Actions Workflow over the previous month

• Host: GitHub
• URL: https://github.com/urcomputeringpal/workflow-run-history
• Owner: urcomputeringpal
• License: apache-2.0
• Created: 2023-05-15T22:54:45.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-17T00:26:35.000Z (about 1 month ago)
• Last Synced: 2024-10-19T00:59:08.600Z (29 days ago)
• Topics: actions, github-actions, performance, reliability
• Language: TypeScript
• Homepage:
• Size: 164 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# workflow-run-history

Adds a Markdown Step Summary explaining the historical performance and success rate of a workflow over the previous week.

-   Compares performance / success rate against other workflows runs on the default branch, PRs, and tags

-   Allows setting performance and success rate targets

-   Outputs values that indicate whether or not the workflow is meeting its targets

## Example

https://github.com/urcomputeringpal/workflow-run-history/actions/runs/5079482931

## Usage

```yaml

name: test

on:

    pull_request:

    push:

        branches:

            - main

    schedule:

        - cron: "0 * * * *"

jobs:

    test:

        runs-on: ubuntu-latest

        steps:

            - run: sleep 5

    performance:

        needs: test

        runs-on: ubuntu-latest

        steps:

            - uses: urcomputeringpal/workflow-run-history@v0

              id: history

              timeout-minutes: 2

              with:

                  # # Target performance

                  # Target an average workflow runtime of 60 seconds.

                  target-seconds: "60"

                  target-percentile: "50"

                  # # Target success rates

                  # This workflow should complete 99% of the time on the default branch.

                  target-default-success-rate: "99"

                  # This workflow should complete 90% of the time on PRs.

                  target-pr-success-rate: "90"

                  # filter-actor: "urcomputeringpal"

                  # filter-branch: "main"

                  # filter-event: "push"

            - run: |

                  echo "This workflow run hit its target performance: ${{ steps.history.outputs.hit-target-seconds }}"

                  echo "This workflow has historically hit its target performance on PRs: ${{ steps.history.outputs.hit-target-pr-success-percentile }}"

                  echo "This workflow has historically hit its target success rate on main: ${{ steps.history.outputs.hit-target-default-success-rate }}"

```