This repository has been archived by the owner on Aug 23, 2022. It is now read-only.
forked from benchmark-action/github-action-benchmark
/
action.yml
75 lines (73 loc) · 3.45 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
name: 'Continuous Benchmark'
author: 'rhysd <https://rhysd.github.io>'
description: 'Continuous Benchmark using GitHub pages as dash board for keeping performance'
branding:
icon: 'fast-forward'
color: 'blue'
inputs:
name:
description: 'Name of the benchmark. This value must be identical among all benchmarks'
required: true
default: 'Benchmark'
tool:
description: 'Tool to use get benchmark output. One of "cargo", "go", "benchmarkjs", "pytest"'
required: true
output-file-path:
description: 'A path to file which contains the benchmark output'
required: true
gh-pages-branch:
description: 'Branch for gh-pages'
required: true
default: 'gh-pages'
benchmark-data-dir-path:
description: 'Path to directory which contains benchmark files on GitHub pages branch'
required: true
default: 'dev/bench'
github-token:
description: 'GitHub API token to pull/push GitHub pages branch and deploy GitHub pages. For public repository, this must be personal access token for now. Please read README.md for more details'
required: false
auto-push:
description: 'Push GitHub Pages branch to remote automatically. This option requires github-token input'
required: false
default: false
skip-fetch-gh-pages:
description: 'Skip pulling GitHub Pages branch before generating an auto commit'
required: false
default: false
comment-always:
description: 'Leave a comment with benchmark result comparison. To enable this feature, github-token input must be given as well'
required: false
default: false
save-data-file:
description: 'Save the benchmark data to external file'
required: false
default: true
comment-on-alert:
description: 'Leave an alert comment when current benchmark result is worse than previous. Threshold is specified with alert-comment-threshold input. To enable this feature, github-token input must be given as well'
required: false
default: false
alert-threshold:
description: 'Threshold which determines if an alert should happen or not. Percentage value such as "150%". For example, 150% means that an alert happens when current benchmark result is 1.5x worse than previous'
required: false
default: '200%'
fail-on-alert:
description: 'Workflow fails when alert comment happens'
required: false
# Note: Set to false by default since this action does not push to remote by default. When workflow
# fails and auto-push is not set, there is no chance to push the result to remote.
default: false
fail-threshold:
description: 'Threshold which determines if the current workflow fails. Format is the same as alert-threshold input. If this value is not specified, the same value as alert-threshold is used'
required: false
alert-comment-cc-users:
description: 'Comma separated GitHub user names which start with @ (e.g. "@foo,@bar"). They will be mentioned in commit comment for alert.'
required: false
external-data-json-path:
description: 'JSON data file for storing benchmark results. When this input is set, github-action-benchmark no longer uses Git branch to store data. Instead, it reads and appends benchmark data from/to the file. User must store the file anywhere'
required: false
max-items-in-chart:
description: 'Max data points in a benchmark chart to avoid making the chart too busy. Value must be unsigned integer. No limit by default'
required: false
runs:
using: 'node12'
main: 'src/index.js'