A suite of crates written by Bitshift to help build software faster.
These are the crates built within this repo:
| Crate | Description | Version |
|---|---|---|
uhoh |
Declarative enum errors with HTTP integration | |
olly |
Observability (o11y) presets for Bitshift applications |
The following sections explain the overall engineering process we use in this repo.
Adding a new crate to this repo is done by running the rust:new Mise task. It
will prompt you for a few bits of state, and then will wire everything up that
needs to be.
mise run rust:new --name=my-new-crate
Releasing new versions of crates to crates.io is handled by CI. To release a new version of any crate, follow this simple process:
- Merge your changes to the crate into
mainvia a Pull Request. - Wait for the Release Please workflow to complete.
- Review and merge the relevant release PR from @bitshift-releaser[bot].
- The PR being merged will trigger a new release to get created, and the Release workflow will run once per crate released.
Once the Release workflow is completed, the affected crates should be updated on crates.io; docs.rs publishing may take some time to complete, so just be patient for rustdocs.
Tip
Crates with sub-crates (such as uhoh with uhoh-macros) stored in their
respective directories will get versioned and released together. If you need
to separate the release flows of sibling crates, don't nest their directories.
We want our crates to have useful, helpful documentation such that consumers within and without Bitshift can enjoy discovering and working with our features. We expect our Rust code to be fully documented in the standard way for other Rust projects (via Rustdoc), so all documentation should be handled by doc comments in crates and READMEs that get attached to the relevant crates.
To generate and open documentation locally with all features enabled, run:
mise run docs:rust <crate>For example:
# open the documentation for the `uhoh` crate
mise run docs:rust uhohThis project (and all its crates) is provided under the Apache 2.0 license.