Alex Azarov
8bcf6a7242
Fix API documentation links in README.md ( #258 )
...
This PR removes `main` branch name from API docs URLs, making them
always point to the latest stable release instead of the main branch.
For most of developers this README.md is the main entry point when
installing the library, so pointing them to API docs for the latest
stable release makes more sense then the main branch which may contain
un-released API or breaking changes.
2025-06-30 06:56:43 -07:00
Clinton Nkwocha
5fd8063331
Enable strict concurrency ( #213 )
...
Motivation:
To catch potential data races at build time.
Modifications:
- Bump Swift tools version from 5.8 to 5.9 in Package.swift.
- Enable strict concurrency in Package.swift.
- Adjust the documentation section on the supported Swift versions.
- Implement minor fixes for the surfaced strict concurrency warnings.
- Add `-require-explicit-sendable` to the 6.0, nightly 6.0 and nightly
main CI checks.
Result:
Strict concurrency adoption.
2024-12-13 18:24:01 +00:00
Yim Lee
b6de7e7235
Remove note from README about API instability ( #149 )
...
I think we can remove that note now that the library has 1.0.0 tag.
2023-10-13 08:58:41 +01:00
David Nadoba
eddfe84a03
Remove Xcode specific benchmark documentation ( #141 )
...
It is now included in the official docs: https://github.com/ordo-one/package-benchmark/commit/070dee37abe72c0a3d7e0feff5dca3effd66b541
2023-09-25 02:22:19 -07:00
David Nadoba
7815247199
Adopt package-benchmark ( #125 )
...
* Add `package-benchmark`
* use local dependencies
* split into multiple targets
* fix benchmark plugin
* refactor file structure
* self review
* Fix review comment
* Apply review feedback
* use `scaledIterations`
* don’t require the parent folder to be named `swift-certificates`
* install jemalloc
* use new `metricP90AbsoluteThresholds` export format
* update metrics
* use automated threshold import
* merge main and update allocation counters
* adopt `swift-format` for benchmarks
* add license headers
* use latest threshold file format
* delete old integration tests
* use released version
* revork folder structure
and add BlackHole module
* crash in debug configuration
* swift-format
* update baselines
* Move to single target
* update swift-format script
* enable arc for `Verifier`
* update to `package-benchmark` `1.11.0`
* update to `package-benchmark` `1.11.1`
* update benchmark metrics
* update metrics captured
* include release count
* move `.benchmarkBaselines` to nested `.gitignore`
* swift-format
* Fix `.gitignore`
* Add documentation
* change wording
* remove version number
* remove benchmarks folder
* add uppercase Benchmarks folder
* fix formatting script
* update readme with new uppercase folder name
* update Benchmarks folder name in docker compose
* drop allocation limits
2023-09-21 14:17:49 +01:00
Honza Dvorsky and David Nadoba
6911f23768
[README] Add a leading dot to upToNextMinor ( #83 )
...
Co-authored-by: David Nadoba <d_nadoba@apple.com >
2023-05-10 02:03:02 -07:00
David Nadoba
b0dda3dc39
Clean up the upToNextMinor ( #69 )
...
Minor cleanup in the `upToNextMinor` code in the README.
2023-04-19 17:58:32 +02:00
Cory Benfield
229051f3ad
Code-review feedback
2023-03-01 11:16:35 +00:00
Cory Benfield
941e966ccf
Add README and collateral
2023-03-01 10:35:09 +00:00
Cory Benfield
42be2505cc
Initial commit
2022-11-16 15:50:52 +01:00