Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic development instructions #11

Merged
merged 1 commit into from
Mar 16, 2023
Merged

Conversation

bennettgoble
Copy link
Member

Include notes about pre-commit, benchmarks.

@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Merging #11 (1f67ae0) into main (8f5faba) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #11   +/-   ##
=======================================
  Coverage   89.83%   89.83%           
=======================================
  Files           6        6           
  Lines         797      797           
=======================================
  Hits          716      716           
  Misses         81       81           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more


### Benchmarks

Benchmarks from commits to `main` are published [here](https://secondlife.github.io/python-llsd/dev/bench/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could the check unconditionally produce a summary of perf changes even when they're not negative?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is supposed to be an option to produce job summary reports containing comparison data, https://github.com/benchmark-action/github-action-benchmark#pr-summary However, when I tried to enable this the action failed due to a git operation failing. This seems to be related to an open issue, benchmark-action/github-action-benchmark#158

Copy link
Member Author

@bennettgoble bennettgoble Mar 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There seems to be quite a bit of recent activity in github-action-benchmark, and that issue is comparatively new. Once fixed/addressed we can try to re-enable summary-always: true

@nat-goodspeed nat-goodspeed merged commit c4035fb into main Mar 16, 2023
@nat-goodspeed nat-goodspeed deleted the signal/bench-readme branch March 16, 2023 21:20
@github-actions github-actions bot locked and limited conversation to collaborators Mar 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants