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

Document developer tools #723

Merged
merged 1 commit into from
Apr 22, 2024
Merged

Document developer tools #723

merged 1 commit into from
Apr 22, 2024

Conversation

dani-garcia
Copy link
Member

Type of change

- [ ] Bug fix
- [ ] New feature development
- [ ] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [ ] Build/deploy pipeline (DevOps)
- [x] Other

Objective

Documented the tools we use for development. Sadly couldn't integrate nextest into bacon as the output is too different and bacon relies on parsing it to work. I still included it in the list for the cases where devs run it manually.

I've also removed the lto = true instruction from bitwarden-napi, as it was ignored in favor of the workspace setting and was producing a warning.

Copy link
Contributor

Logo
Checkmarx One – Scan Summary & Detailsf25ecd38-0ffd-4e90-ba61-009c30cbea97

No New Or Fixed Issues Found

Copy link

codecov bot commented Apr 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.66%. Comparing base (dfe067e) to head (7e1b1a1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #723   +/-   ##
=======================================
  Coverage   60.66%   60.66%           
=======================================
  Files         173      173           
  Lines       10628    10628           
=======================================
  Hits         6447     6447           
  Misses       4181     4181           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dani-garcia dani-garcia requested a review from Hinton April 19, 2024 15:28
- `bacon`: This is a CLI background code checker. We provide a configuration file with some of the
most common tasks to run (`check`, `clippy`, `test`, `doc` - run `bacon -l` to see them all). This
tool needs to be installed separately by running `cargo install bacon --locked`.
- `nexttest`: This is a new and faster test runner, capable of running tests in parallel and with a
Copy link
Member

Choose a reason for hiding this comment

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

Should we update bacon test to run nexttest?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's what I tried initially, but bacon relies on parsing the output from cargo test to show the failed test output, which didn't work correctly with cargo nextest sadly.

@dani-garcia dani-garcia merged commit 10d04b4 into main Apr 22, 2024
76 checks passed
@dani-garcia dani-garcia deleted the ps/tools-doc branch April 22, 2024 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants