From 642d7b3b50eed6423bf28b6cd08e35d9fbe850b0 Mon Sep 17 00:00:00 2001 From: Tyler Sengia Date: Thu, 28 Dec 2023 00:18:06 -0500 Subject: [PATCH 1/2] docs: Add development standards and release process --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 000010a..aa0afb0 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,9 @@ http-error https://another-website-somewhere.org/ ``` ## Development +Since version 1.0.0, `spider-crab` uses the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) standard for commit messages. +However, if you make contributions that do not follow the Conventional Commits standard, then a maintainer will squash your commits and make a merge commit that follows the Conventional Commits standard. + `spider-crab` uses the default `cargo fmt` formatter and `cargo clippy` linter. To run the integration tests, run: `cargo test`. @@ -102,4 +105,14 @@ cargo test 4. Generate an HTML report file with grcov: ```bash grcov . --binary-path ./target/debug/deps/ -s . -t html --branch --ignore-not-existing --ignore '../*' --ignore "/*" --ignore 'target/*/build/*5ever' -o target/coverage/html -``` \ No newline at end of file +``` + +## Release Process +This repo uses two workflows in `.github/workflows`: +- `lint_fmt_test.yml` - Checks Pull Requests, runs formatter, clippy, `cargo check`, `cargo test`, and ensures that the version number in `Cargo.toml` was bumped. +- `release.yml` - Performs a `cargo build --release` and uploads the compiled binary to GitHub + +To make a new release, perform the following: +- Make a tag on the `main` branch that matches the version number in `Cargo.toml`. Update `Cargo.toml` if necessary. +- Push the tag. +- Watch for the GitHub workflow to finish and upload the build artifacts. \ No newline at end of file From 34b7000dea3b51de6af39c4a1b51c90daa49b6e6 Mon Sep 17 00:00:00 2001 From: Tyler Sengia Date: Thu, 28 Dec 2023 00:18:27 -0500 Subject: [PATCH 2/2] chore: Bump Cargo.toml version to 1.0.0 --- Cargo.lock | 2 +- Cargo.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 25400d8..3516411 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1575,7 +1575,7 @@ dependencies = [ [[package]] name = "spider-crab" -version = "0.1.5" +version = "1.0.0" dependencies = [ "async-recursion", "clap", diff --git a/Cargo.toml b/Cargo.toml index a60a93b..289a97e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "spider-crab" -version = "0.1.5" +version = "1.0.0" edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html