Update referenced versions in READMEs and add note about doing so to PUBLISH.md

pull/137/head
Chip Senkbeil 2 years ago
parent fd325e4523
commit 30548cdbfb
No known key found for this signature in database
GPG Key ID: 35EF1F8EC72A4131

@ -13,7 +13,14 @@ that the release version is specified in the format: `[VERSION] - DATE`.
3. At the bottom, add a new link for the current version.
4. Update the `[Unreleased]` link with the latest tag.
## 2. Update Crate Versions
## 2. Update READMEs
Each crate README has a reference to installing a specific version and needs to
be updated.
e.g. Open `distant-core/README.md` and replace `0.17` with `0.18` if applicable
## 3. Update Crate Versions
Run a command to update the crate versions. An easy way is to use `sed`.
@ -23,11 +30,11 @@ and new versions would be specified.
*Make sure to review the changed files! Sometimes a version overlaps with
another crate and then we've bumped something wrong!*
## 3. Build to get Cargo.lock update
## 4. Build to get Cargo.lock update
Run `cargo build` to get a new `Cargo.lock` refresh and commit it.
## 4. Tag Commit
## 5. Tag Commit
Tag the release commit with the form `vMAJOR.MINOR.PATCH` by using
`git tag vMAJOR.MINOR.PATCH` and publish the tag via `git push --tags`.
@ -35,7 +42,7 @@ Tag the release commit with the form `vMAJOR.MINOR.PATCH` by using
Once the tag is pushed, a new job will start to build and publish the artifacts
on Github.
## 5. Publish Crates
## 6. Publish Crates
Now, `cd` into each sub-crate and publish. Sometimes, it takes a little while
for a crate to be indexed after getting published. This can lead to the publish
@ -46,6 +53,6 @@ of a downstream crate to fail. If so, try again in a couple of seconds.
3. **distant-ssh2:** `(cd distant-ssh2 && cargo publish)`
4. **distant:** `cargo publish`
## 6. Celebrate
## 7. Celebrate
Another release done!

@ -28,7 +28,7 @@ You can import the dependency by adding the following to your `Cargo.toml`:
```toml
[dependencies]
distant-core = "0.17"
distant-core = "0.18"
```
## Features

@ -25,7 +25,7 @@ You can import the dependency by adding the following to your `Cargo.toml`:
```toml
[dependencies]
distant-net = "0.17"
distant-net = "0.18"
```
## Features

@ -26,7 +26,7 @@ You can import the dependency by adding the following to your `Cargo.toml`:
```toml
[dependencies]
distant-ssh2 = "0.17"
distant-ssh2 = "0.18"
```
## Examples

Loading…
Cancel
Save