Skip to content

Commit

Permalink
Merge branch 'master' into chart.js-v4
Browse files Browse the repository at this point in the history
  • Loading branch information
martincostello authored Sep 15, 2024
2 parents b5174d3 + c3a5e4e commit 3b052a7
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 8 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/validate-action-typings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Validate action typings

on:
push:
branches: [master]
pull_request:
branches: [master]
workflow_dispatch:

jobs:
validate-typings:
runs-on: "ubuntu-latest"
steps:
- uses: actions/checkout@v4
- uses: typesafegithub/github-actions-typing@v1
57 changes: 57 additions & 0 deletions action-types.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
inputs:
name:
type: string
tool:
type: enum
allowed-values:
- cargo
- go
- benchmarkjs
- pytest
- googlecpp
- catch2
- julia
- jmh
- benchmarkdotnet
- benchmarkluau
- customBiggerIsBetter
- customSmallerIsBetter
output-file-path:
type: string
gh-pages-branch:
type: string
gh-repository:
type: string
benchmark-data-dir-path:
type: string
github-token:
type: string
ref:
type: string
auto-push:
type: boolean
skip-fetch-gh-pages:
type: boolean
comment-always:
type: boolean
summary-always:
type: boolean
save-data-file:
type: boolean
comment-on-alert:
type: boolean
alert-threshold:
type: string
fail-on-alert:
type: boolean
fail-threshold:
type: string
alert-comment-cc-users:
type: list
separator: ','
list-item:
type: string
external-data-json-path:
type: string
max-items-in-chart:
type: integer
16 changes: 8 additions & 8 deletions examples/benchmarkdotnet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@ C# example for benchmarking with `Benchmark.Net`
================================================

- [Workflow for this example](../../.github/workflows/benchmarkdotnet.yml)
- [Action log of this example](https://github.com/rhysd/github-action-benchmark/actions?query=workflow%3A%22Benchmark.Net+example%22)
- [Action log of this example](https://github.com/benchmark-action/github-action-benchmark/actions?query=workflow%3A%22Benchmark.Net+example%22)
- [Benchmark results on GitHub pages](https://benchmark-action.github.io/github-action-benchmark/dev/bench/)

This directory shows how to use [`github-action-benchmark`](https://github.com/rhysd/github-action-benchmark)
with [`Benchmark.Net`](https://benchmarkdotnet.org/).
This directory shows how to use [`github-action-benchmark`](https://github.com/benchmark-action/github-action-benchmark)
with [`BenchmarkDotNet`](https://benchmarkdotnet.org/).

## Run benchmarks

Official documentation for usage of `Benchmark.Net`:
Official documentation for usage of `BenchmarkDotNet`:

https://benchmarkdotnet.org/articles/overview.html

You should add the `Benchmark.Net` package to your test project and configure your tests according to the [Getting Started](https://benchmarkdotnet.org/articles/guides/getting-started.html) docs. A simple test file might look like
You should add the `BenchmarkDotNet` package to your test project and configure your tests according to the [Getting Started](https://benchmarkdotnet.org/articles/guides/getting-started.html) docs. A simple test file might look like


```csharp
Expand Down Expand Up @@ -64,7 +64,7 @@ You can then run the tests using `dotnet run`. It's _very_ important that you e

Store the benchmark results with step using the action. Please set `benchmarkdotnet` to `tool` input.

By default, Benchmark.Net will output results files to the current directory in a structure like:
By default, BenchmarkDotNet will output results files to the current directory in a structure like:

```
BenchmarkDotNet.Artifacts
Expand All @@ -81,10 +81,10 @@ You want to get the path of the `-report-full-compressed.json` report for use wi

```yaml
- name: Store benchmark result
uses: rhysd/github-action-benchmark@v1
uses: benchmark-action/github-action-benchmark@v1
with:
tool: 'benchmarkdotnet'
output-file-path: BenchmarkDotNet.Artifacts/results/Sample.Benchmarks-report-full-compressed.json
```
Please read ['How to use' section](https://github.com/rhysd/github-action-benchmark#how-to-use) for common usage.
Please read [How to use section](https://github.com/benchmark-action/github-action-benchmark#how-to-use) for common usage.

0 comments on commit 3b052a7

Please sign in to comment.