Skip to content

Commit

Permalink
Update developer documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Niederb committed Oct 31, 2024
1 parent e679ed3 commit 6fe674b
Showing 1 changed file with 3 additions and 15 deletions.
18 changes: 3 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,11 @@

## TODO List for a new Release
If a new release is released, the following tasks need to be done:
1. Update the .toml versions in accordance with the [Semantic Versioning](#semantic-versioning) section.
1. Update the .toml versions in accordance with the [Semantic Versioning](../README.md#version-numbers) section.
2. Add a new tag to the desired commit, see the [Tag generation](#tag-generation) section.
3. Update and release the new release.
4. Publish to crates.io, see https://doc.rust-lang.org/cargo/reference/publishing.html for more info. Important: 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.

## TODO list for a new Parity release branch
To follow a new partiy branch release, the following needs to be done:
1. Create a new branch with the same name as the parity release and update dependencies. See this [commit](https://github.com/scs/substrate-api-client/commit/a50833a922ff98ae59e2fc587e0ab5466b3acab2) for an example update. Release branches are based on a specific api-client release, not master.
2. Push the changes on the new branch and check CI result. CI will be triggered automatically if the branch follows the naming scheme of `release-polkadot-v[0-9]+.[0-9]+.[0-9]+*`. Results can be looked up [here](https://github.com/scs/substrate-api-client/actions)
3. After CI passed, update the associated release text with the new branch. See [this release](https://github.com/scs/substrate-api-client/releases/tag/v0.16.0) as an example.
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.
5. Publish to crates.io, see https://doc.rust-lang.org/cargo/reference/publishing.html for more info.


## Automatic Release generation
Expand All @@ -23,13 +18,6 @@ Example release: https://github.com/scs/substrate-api-client/releases/tag/v0.10.

The `🎉 Featuring` section has been created manually. It should show the user directly what has been updated and what new features have been added (not only PR names)

### Semantic Versioning
This is not yet checked or automated by CI, but it may be in the future. Currently, the api-client is following the semantic versioning în pre-release as the public API may change any time.
In case a new release is triggered, the `.toml` versions of the crates, that have been updated since the last release, should be increased.
- In case of breaking API changes, the minor version should be increased (`0.9.3 -> 0.10.0`)
- In case of changes, which do not break the API, the patch version should be increased (`0.9.3 -> 0.9.4`).
The version of the main .toml should be same as the one of the release.

### PR Labels
For automatic release generation, `E` and `F` labels are used.

Expand Down

0 comments on commit 6fe674b

Please sign in to comment.