ordo-one / package-benchmark

Swift benchmark runner with many performance metrics and great CI support
Apache License 2.0
326 stars 25 forks source link

feat: Add convenience blackHole() to Benchmark, fix up documentation links #124

Closed hassila closed 1 year ago

hassila commented 1 year ago

Description

Documentation links were broken after restructuring, fixing them. Also adding convenience blackHole() for easier disambiguation.

How Has This Been Tested?

Manual doc generation in Xcode.

Minimal checklist:

github-actions[bot] commented 1 year ago

Pull request benchmark comparison [ubuntu-latest] with 'main' run at 2023-03-22T08:48:12+00:00 Pull request had performance regressions

codecov[bot] commented 1 year ago

Codecov Report

Merging #124 (3e33f4e) into main (6c80fcf) will decrease coverage by 0.03%. The diff coverage is 0.00%.

Additional details and impacted files [![Impacted file tree graph](https://codecov.io/gh/ordo-one/package-benchmark/pull/124/graphs/tree.svg?width=650&height=150&src=pr&token=hXHmhEG1iF&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one)](https://codecov.io/gh/ordo-one/package-benchmark/pull/124?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) ```diff @@ Coverage Diff @@ ## main #124 +/- ## ========================================== - Coverage 78.80% 78.77% -0.03% ========================================== Files 22 22 Lines 2510 2511 +1 ========================================== Hits 1978 1978 - Misses 532 533 +1 ``` | [Impacted Files](https://codecov.io/gh/ordo-one/package-benchmark/pull/124?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) | Coverage Δ | | |---|---|---| | [Sources/BenchmarkSupport/Benchmark.swift](https://codecov.io/gh/ordo-one/package-benchmark/pull/124?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one#diff-U291cmNlcy9CZW5jaG1hcmtTdXBwb3J0L0JlbmNobWFyay5zd2lmdA==) | `70.77% <0.00%> (-0.55%)` | :arrow_down: | | [Impacted Files](https://codecov.io/gh/ordo-one/package-benchmark/pull/124?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) | Coverage Δ | | |---|---|---| | [Sources/BenchmarkSupport/Benchmark.swift](https://codecov.io/gh/ordo-one/package-benchmark/pull/124?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one#diff-U291cmNlcy9CZW5jaG1hcmtTdXBwb3J0L0JlbmNobWFyay5zd2lmdA==) | `70.77% <0.00%> (-0.55%)` | :arrow_down: | ------ [Continue to review full report in Codecov by Sentry](https://codecov.io/gh/ordo-one/package-benchmark/pull/124?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://codecov.io/gh/ordo-one/package-benchmark/pull/124?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one). Last update [6c80fcf...3e33f4e](https://codecov.io/gh/ordo-one/package-benchmark/pull/124?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one).
github-actions[bot] commented 1 year ago

:tada: This PR is included in version 1.1.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: