Learn how the CodSpeed metrics work
-1
, the slower it is.
A positive performance metric means
that the benchmark is faster than the previous commit. Its value can go up to
to denote massive speed improvements.
Naturally, when the benchmark is as fast as the previous commit, the performance
metric is .
10%
(which is
equivalent to 0.1
). The value can be set from 0%
to 50%
by an admin of the
project. More information about setting the threshold can be found in the
customization documentation.
n
being the number of benchmarks.
For example, with impacts:[0.1, 0, -0.3]
and a threshold of0.25
, the overall commit impact will be-0.3
.
For example, with impacts:[0.1, 0.3, -0.2]
and a threshold of0.25
, the overall commit impact will be0.3
.
For example, with impacts:[0.1, 0.3, -0.2]
and a threshold of0.5
, the overall commit impact will be approximately0.0459
.
head
branch and a
base
branch, the baseline report will be the report of the latest commit of
the base
branch with a CodSpeed run.
action/checkout
in GitHub Actions,
the checked-out commit of a pull request will be the merge
commit of the pull request. This means that GitHub will create a
merge commit M between the base
branch and the head
branch, and use it
as the checked-out commit.HEAD
commit C of the base
branch and the merge commit M. The report will thus only include the changes
of commits B1 and B2.
feat-branch
, the baseline report will
be updated to the latest commit of the base
branch with a CodSpeed run.pull_request
event for GitHub Actions and merge_request_event
for GitLab CI.
If you run CodSpeed on a different event, the branch base selection algorithm defined below will be used instead.main
branch. A new commit C is pushed on the main
branch. The baseline report
for C will be the report of the commit B.