TheAngryByrd / MiniScaffold

F# Template for creating and publishing libraries targeting .NET 6.0 `net6.0` or console apps .NET 6.0 `net6.0`.
https://www.jimmybyrd.me/MiniScaffold/
MIT License
267 stars 31 forks source link

Add Benchmarking #256

Open TheAngryByrd opened 2 years ago

TheAngryByrd commented 2 years ago

Is your feature request related to a problem? Please describe.

Add benchmarksDotNet and use github-action-benchmark to display them

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

artem-burashnikov commented 9 months ago

Hello. Could you please elaborate on what is expected to be added to templates?

TheAngryByrd commented 9 months ago

What specifically are you looking for in elaboration? Issue points to using the benchmarkDotnet template for benchmarks and then using github-action-benchmark to display them.

artem-burashnikov commented 9 months ago

As I am still very inexperienced, I would like to clarify: you mean that benchmark library to be added to generated templates and a workflow job that catches up any benchmarks that may by defined by user later on?

TheAngryByrd commented 9 months ago

benchmark library to be added to generated templates

Yep! Probably under a benchmarks/ folder similar to how there's src/ or tests/.

a workflow job that catches up any benchmarks that may by defined by user later on

Yep! The workflow should be preconfigured to pick up the templated benchmark. Should also be easy to amend when someone creates new benchmarks.