chore(ci): Make use of cargo-release's rate-limit setting (#1267)

* Update Cargo.toml and RELEASES.md

* Change some wording

* use reference-style links

* format markdown file

* grammar

* update text

* use release.toml

* update RELEASES.md

* grammar

---------

Co-authored-by: Ranadeep Biswas <mail@rnbguy.at>

Author: seanchen1991

RELEASES.md

@@ -4,14 +4,14 @@ Our release process is as follows:
 
 1. In a new branch `release/vX.Y.Z`, update the [changelog](./CHANGELOG.md) to
    reflect and summarize all changes in the release. This involves:
-   1. Running `unclog build -u` and copy pasting the output at the top of the
+   1. Running `unclog build -u` and copy-pasting the output at the top of the
       `CHANGELOG.md` file, making sure to update the header with the new
       version.
    2. Running `unclog release --editor <editor> vX.Y.Z` to create a summary of
-      all of the changes in this release.
+      all the changes in this release.
       1. Your text editor will open. Write the release summary, and close the
-         editor. Make sure to include a comment on whether or not the release
-         contains consensus-breaking changes.
+         editor. Make sure to include a comment on whether the release contains
+         consensus-breaking changes.
       2. Add this same summary to `CHANGELOG.md` as well.
    3. Committing the updated `CHANGELOG.md` file and `.changelog` directory to
       the repo.
@@ -21,8 +21,8 @@ Our release process is as follows:
    version of that crate.
    1. bump the version in `crates/ibc-derive/Cargo.toml`
    2. Publish `ibc-derive` with `cargo publish -p ibc-derive`
-4. Bump the versions of all crates to the new version in their Cargo.toml and in
-   the root `Cargo.toml` as well, and push these changes to the release PR.
+4. Bump the versions of all crates to the new version in their `Cargo.toml` and
+   in the root `Cargo.toml` as well, and push these changes to the release PR.
    - If you released a new version of `ibc-derive` in step 3, make sure to
      update that dependency.
    - Verify that there is no dev-dependency among the workspace crates. This is
@@ -35,28 +35,22 @@ Our release process is as follows:
      ![alt test](docs/dev-deps-graph.png) The dev dependencies are colored with
      blue arrows. Currently, there are no blue arrows, i.e. there is no dev
      dependency among the IBC crates. It is advised to avoid any dev dependency
-     because of release order complicacy (except maybe inside `ibc-testkit`, as
-     it is the top crate that depends on `ibc` crate and no other crate depends
-     on it).
-   - In order to resolve such a situation, the dev dependencies other than
-     `ibc-testkit` can be manually released to crates.io first so that the
-     subsequent crates that depend on them can then be released via the release
-     process. For instructions on how to release a crate on crates.io, refer
-     [here](https://doc.rust-lang.org/cargo/reference/publishing.html).
-5. Beware of [crates-io rate limit][cargo-release-rate-limit]. It is 5 for
-   publishing new crates and 30 for publishing existing crates. But the number
-   of our crates has reached 31. So we publish a leaf crate, `ibc-primitives`
-   manually and release the rest of the 30 crates via CI.
-   - Release `ibc-primitives` by running:
-   ```sh
-   cargo release -p ibc-primitives --no-push --no-tag --allow-branch main --execute
-   ```
-   - Validate the number of crates that need to be released via CI, it can not
-     be more than 30.
-   - There should be a 10 minutes delay between the release of `ibc-primitives`
-     and the release of the rest of the crates on CI.
-   - If new crates are added, we need to recompute the set of crates that we
-     want to release via CI. The rest must be released manually.
+     because of release order complication (except maybe inside `ibc-testkit`,
+     as it is the top crate that depends on `ibc` crate and no other crate
+     depends on it).
+   - To resolve such a situation, the dev dependencies other than `ibc-testkit`
+     can be manually released to crates.io first so that the subsequent crates
+     that depend on them can then be released via the release process. For
+     instructions on how to release a crate on crates.io, refer
+     [here][publishing].
+5. Validate the number of new and existing crates that need to be released via
+   CI.
+   1. crates.io imposes a [rate limit][crates-io-rate-limit] of publishing 1
+      crate per minute after a burst of 10 crates.
+   2. Also, [`cargo-release`][cargo-release-rate-limit] rejects publishing more
+      than 5 new crates or 30 existing crates by default. If we need to publish
+      more than these limits, we need to update `release.toml` at workspace
+      root.
 6. Run `cargo doc -p ibc --all-features --open` locally to double-check that all
    the documentation compiles and seems up-to-date and coherent. Fix any
    potential issues here and push them to the release PR.
@@ -75,7 +69,7 @@ Our release process is as follows:
        locally to publish any missing crates from this release. This step
        requires the appropriate privileges to push crates to [crates.io].
     2. If there is any new crate published locally, add
-       [ibcbot](https://crates.io/users/ibcbot) to its owners list.
+       [ibcbot](https://crates.io/users/ibcbot) to its owners' list.
     3. In case problems arise from the source files, fix them, bump a new patch
        version (e.g. `v0.48.1`) and repeat the process with its corresponding
        new tag.
@@ -94,4 +88,6 @@ All done! 🎉
 
 [crates.io]: https://crates.io
 [release.yaml]: https://github.com/cosmos/ibc-rs/blob/main/.github/workflows/release.yaml
-[cargo-release-rate-limit]: https://github.com/crate-ci/cargo-release/blob/4b09269/src/steps/mod.rs#L214-L268
+[crates-io-rate-limit]: https://github.com/rust-lang/crates.io/pull/1596
+[cargo-release-rate-limit]: https://github.com/crate-ci/cargo-release/blob/54ad949/src/config.rs#L493-L498
+[publishing]: https://doc.rust-lang.org/cargo/reference/publishing.html

release.toml

@@ -0,0 +1,3 @@
+# specifies the rate limit for cargo-release when publishing existing packages
+# default value: { new-packages = 5, existing-packages = 30 }
+rate-limit = { existing-packages = 40 }