Development

Development environment

TODO: Write out details for the development environment.

Version release procedure

A GitHub Actions workflow using release-plz is set up to automatically create the CHANGELOG.md and a release PR whenever new commits are pushed to the main branch.

The release PR stays open until we want to release a new version, any changes to main will be added in the PR. When we want to release a new version, all we have to do is merge the PR and the actions workflows will take care of the rest.

Release-plz will publish the nbsp crate (using trusted publishing) and create a release on GitHub.

Once a new release is created on GitHub the release binary workflow will then compile the nbsp binary and upload it to the GitHub release.