Skip to content

Commit

Permalink
docs: add deploy document
Browse files Browse the repository at this point in the history
  • Loading branch information
zavakid committed Dec 13, 2024
1 parent 5735714 commit 659e382
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ tbc...
## Example
- [using async fn as handler](crates/web/examples/getting_started.rs)


## Develop
- [deploy new version](deploy.md)

## MSRV
The Minimum Supported Rust Version is 1.74

Expand Down
36 changes: 36 additions & 0 deletions deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# deploy creates

This document is about how to publish the micro-http workspaces to the creates.io.

## Check cargo-workspaces

First you need to install cargo-workspaces if it's not installed on your machine.

Check from [github](https://github.com/pksunkara/cargo-workspaces) or [crates.io](https://crates.io/crates/cargo-workspaces)

### Check cargo-workspaces in the path
```bash
cargo ws version
```
If not in the path, install cargo-workspaces

```bash
cargo install cargo-workspaces
```

## Run Tests

Make sure `cargo test` passed, and workspaces is clean (no git dirty files)

## Dry run

```bash
cargo ws publish --exact --no-git-push --no-individual-tags --dry-run custom ${newVersion}
```

## Publish

cargo ws publish --exact --no-individual-tags custom ${newVersion}



0 comments on commit 659e382

Please sign in to comment.