Skip to content

Commit a561cbd

Browse files
authoredFeb 13, 2025··
Update dev docs with cargo publish cmds (#837)
* update readme * update dev doc * add link to release generation * fix spelling
1 parent d464a6e commit a561cbd

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed
 

‎docs/README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,21 @@
33
## TODO List for a new Release
44
If a new release is released, the following tasks need to be done:
55
1. Update the .toml versions in accordance with the [Semantic Versioning](../README.md#version-numbers) section.
6-
2. Add a new tag to the desired commit, see the [Tag generation](#tag-generation) section.
7-
3. Update and release the new release.
8-
4. Create a new branch and change all github deps to crates.io deps. See https://github.com/scs/substrate-api-client/issues/528 for an example update. The [psvm](https://crates.io/crates/psvm) tool can be useful for updating the polkadot dependencies.
9-
5. Publish to crates.io, see https://doc.rust-lang.org/cargo/reference/publishing.html for more info.
10-
11-
12-
## Automatic Release generation
6+
1. Create a new branch and change all github deps to crates.io deps. See https://github.com/scs/substrate-api-client/issues/812 for an example update. The [psvm](https://crates.io/crates/psvm) tool can be useful for updating the polkadot dependencies.
7+
1. Add a new tag to the desired commit, see the [Tag generation](#tag-generation) section.
8+
1. Update and release the new release (see [Automatic Release Generation](#automatic-release-generation)).
9+
1. Publish to crates.io (see https://doc.rust-lang.org/cargo/reference/publishing.html for more info):
10+
```shell
11+
cargo login <Crates.io Token>
12+
# Only run the next steps if CI has run successfully.
13+
cargo publish -p ac-primitives
14+
cargo publish -p ac-keystore
15+
cargo publish -p ac-node-api
16+
cargo publish -p ac-compose-macros
17+
cargo publish
18+
```
19+
20+
## Automatic Release Generation
1321

1422
A new draft release gets generated upon a new tag with a name matching `v[0-9]+.[0-9]+.[0-9]+*` (E.g. v1.2.3 and v1.2.3-rc1)
1523
See the workflow: https://github.com/scs/substrate-api-client/blob/master/.github/workflows/draft-release.yml

0 commit comments

Comments
 (0)
Please sign in to comment.