Skip to content

Commit

Permalink
chore: Release 1.0.0 (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsengia authored Dec 28, 2023
2 parents 872f83b + 34b7000 commit cabd9fd
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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
```
```

## 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.

0 comments on commit cabd9fd

Please sign in to comment.