actions/README.md

In lorenzwalthert/touchstone: Continuous Benchmarking with Statistical Confidence Based on 'Git' Branches

Github Actions for {touchstone}

This folder contains the Github Actions used when benchmarking a package with {touchstone}. For security reasons the workflow is split into twp separate actions:

• lorenzwalthert/touchstone/actions/receive
• Reads config.json to prepare and run the benchmark job.
• Does not have read & write access.
• Started via PR/push to PR (on main branch).
• lorenzwalthert/touchstone/actions/comment
• Comments the results on the PR that originated the workflow run.
• Has read & write access.
• Started automatically when receive job finishes.
• Will create an additional commit status to the PR check suite.

The actions will always be compatible with the version of {touchstone} of the same git ref, so we recommend using the same tag for both {touchstone} and the actions, e.g. with {touchstone} v0.0.1:

- uses lorenzwalthert/touchstone/actions/receive@v0.0.1

There is also the tag v1 which will occasionally be moved forward for small changes but never for breaking changes. *We recommend this version for pre-CRAN releases.

- uses lorenzwalthert/touchstone/actions/receive@v1

lorenzwalthert/touchstone documentation built on April 20, 2024, 9:57 a.m.