README.md

Basic Things

Project template for Rust based projects hosted on Github. Essentially matklad's Basic Things in action. A generated example with the majority of the features enabled can be found over at basic-things-demo.

Getting started

Create an empty GitHub repository and install cargo-generate before running:

cargo generate gibbz00/basic-things

CI may expect the presence of both CODECOV_TOKEN and CARGO_REGISTRY_TOKEN.

(Reference for template values may be found in ./cargo_generate/values.toml.)

Integrated tools

• git-cliff - Automated changelog generation by the usage of conventional commits.
• mdbook - Optionally enabled to create user focused documentation.
• codecov - Optionally enabled for code coverage uploads and analysis.
• pre-commit - Optionally enabled for quicker validations before committing.

Project aims to provide a comprehensive continuous integration and delivery pipeline. This includes running CI jobs using:

• cargo fmt/clippy - Format and lint check Rust source code and doc comments
• taplo fmt/lint - Format and lint check for TOML files
• lychee - Scan for broken URLs
• cargo-udeps - Find unused dependencies
• typos - Spell checking source code
• cargo-deny - Dependency license and vulnerability scanning
• dependabot - Dependency update scanning
• cocogitto - Assert usage of convetional commits.

Pipeline will also executes tests with cargo, mdbook (if enabled), and cargo llvm-cod for code coverage reporting.

Release pipeline publishes the crates to crates.io and the book to GitHub Pages.

Proposed improvements

• Add support for other Git hosts other than GitHub, e.g Gitea and GitLab.
• Make most features opt-in.
• Cocogitto conventional commit checking in pre-commit commit-msg hook.
• Automated releases with release-plz?