docs: update script readme
Update script readme indicating dev bump script usage and workflow
running script manually.
@@ -8,7 +8,6 @@ To run changelog generator, from the Ockam root path, call
tools/scripts/release/changelog.sh
```
-
## Crate Bump
Crates versions are bumped using [cargo-release](https://github.com/crate-ci/cargo-release/issues) >= v0.18.6. While bumping crates, CHANGELOG.md and README.md files are also updated with the bumped version.
@@ -23,21 +22,16 @@ MODIFIED_RELEASE="signature_core:patch ockam_entity:major" RELEASE_VERSION=minor
```
this bumps `signature_core` as a `patch`, `ockam_entity` as `major` and every other crate as `minor`.
-We can also release a `-dev` version of all crates right after a bump. To release crates,
-```bash
-DEV_VERSION=true tools/scripts/release/crate-bump.sh
-```
-This should be called before a new `git tag` is done so that only crates that are bumped and updated to a `-dev` version.
-
## Crate Publish
-Crates are published to `crates.io` using [cargo-release](https://github.com/crate-ci/cargo-release/issues) right after bump. Only crates that have been updated (comparing `git diff` with last git tag) are published. Crates can also be excluded from being published using the `EXCLUDE_CRATES` variable, to exclude crates, we can optionally specify crates that are to be excluded `EXCLUDE_CRATES="signature_core ockam_core"`, where `signature_core` and `ockam_core` are excluded.
+Crates are published to `crates.io` using [cargo-release](https://github.com/crate-ci/cargo-release) right after bump. Only crates that have been updated (comparing `git diff` with last git tag) are published. Crates can also be excluded from being published using the `EXCLUDE_CRATES` variable, to exclude crates, we can optionally specify crates that are to be excluded `EXCLUDE_CRATES="signature_core ockam_core"`, where `signature_core` and `ockam_core` are excluded.
To publish crates
```bash
PUBLISH_TOKEN=my_crates.io_token EXCLUDE_CRATES="signature_core ockam_core" tools/scripts/release/crate-publish.sh
```
+Note: Require cargo-release >= version 0.18.6
## Tagging
@@ -46,3 +40,22 @@ To perform `git tag`
```bash
COMMIT_SHA=000000000 tools/scripts/release/tagging.sh
```
+
+## Dev Bump
+
+We can also bump crates to a `-dev` version right after a publish. To bump crates,
+```bash
+tools/scripts/release/dev-bump.sh
+```
+This should be called after git tagging is done.
+
+
+## Manual Release
+
+For a manual release to be done, we should
+
+- Generate Changelogs
+- Bump Crates
+- Publish Crates
+- Tag Crates
+- Dev Bump Crates
