Skip to content

Commit

Permalink
ci: update RELEASING.md notes, prep for release, wip
Browse files Browse the repository at this point in the history
  • Loading branch information
MingweiSamuel committed Aug 30, 2024
1 parent c8a6bc4 commit c41787f
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 16 deletions.
11 changes: 9 additions & 2 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ messages, but requires manually intervention to do so in some situations.
```sh
cargo install cargo-smart-release
```
Re-run this command before each release to update the tool before testing locally, as the CI will
always use the latest version.

## Dry run to ensure changelogs can be generated

Expand Down Expand Up @@ -120,13 +122,18 @@ cargo changelog --write <crate_to_be_moved> <other_crate_to_be_moved> ...
```
(This command is provided by `cargo install cargo-smart-release`; don't use any other `cargo changelog` command)

Then, before committing the changes, go through the modified `CHANGELOG.md` files and add a prefix
to the `Commit Statistics` and `Commit Details` headers, for example: `Pre-Move Commit Statistics`/`Pre-Move Commit Details`.
Next (even if there are no changes), go through the modified `CHANGELOG.md` files and add a prefix
to **all** (not just the new) the `Commit Statistics` and `Commit Details` headers, for example:
`Pre-Move Commit Statistics`/`Pre-Move Commit Details`.
This is necessary because otherwise `cargo-smart-release` will treat those sections as auto-generated
and will not preserve them, but then won't regenerate them due to the package moving. Commit the
updated changelogs and cherry-pick that commit to the latest version if you went back in history.
The changelogs should now be safely preserved by future releases.

## Addendum: Renaming crates

TODO

## Addendum: The GitHub App account

So... `cargo smart-release` wants to push to `hydro-project/hydroflow`'s `main` branch. However,
Expand Down
8 changes: 4 additions & 4 deletions hydro_deploy/hydroflow_deploy_integration/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- <csr-id-ba2df44efd42b7c4d37ebefbf82e77c6f1d4cb94/> use `TcpListenerStream` instead of spawning task, fix #659

### Commit Statistics
### Pre-Move Commit Statistics

<csr-read-only-do-not-edit/>

Expand All @@ -20,7 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- 1 commit was understood as [conventional](https://www.conventionalcommits.org).
- 1 unique issue was worked on: [#1121](https://github.com/hydro-project/hydroflow/issues/1121)

### Commit Details
### Pre-Move Commit Details

<csr-read-only-do-not-edit/>

Expand Down Expand Up @@ -73,7 +73,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Auto-configure Hydro Deploy based on Hydroflow+ plans ([`9e27582`](https://github.com/hydro-project/hydroflow/commit/9e275824c88b24d060a7de5822e1359959b36b03))
</details>

### Commit Statistics
### Pre-Move Commit Statistics

<csr-read-only-do-not-edit/>

Expand All @@ -82,7 +82,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- 3 commits were understood as [conventional](https://www.conventionalcommits.org).
- 2 unique issues were worked on: [#1046](https://github.com/hydro-project/hydroflow/issues/1046), [#986](https://github.com/hydro-project/hydroflow/issues/986)

### Commit Details
### Pre-Move Commit Details

<csr-read-only-do-not-edit/>

Expand Down
20 changes: 10 additions & 10 deletions hydro_deploy/hydroflow_plus_deploy/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
We could make the publicly facing `stdout`, `stderr` APIs return `impl Stream<Output = String>` in the future, maybe
- <csr-id-141eae1c3a1869fa42756250618a21ea2a2c7e34/> replace some uses of `tokio::sync::RwLock` with `std::sync::Mutex` #430 (3/3)

### Commit Statistics
### Pre-Move Commit Statistics

<csr-read-only-do-not-edit/>

Expand All @@ -80,7 +80,7 @@
- 4 commits were understood as [conventional](https://www.conventionalcommits.org).
- 4 unique issues were worked on: [#1339](https://github.com/hydro-project/hydroflow/issues/1339), [#1346](https://github.com/hydro-project/hydroflow/issues/1346), [#1347](https://github.com/hydro-project/hydroflow/issues/1347), [#1356](https://github.com/hydro-project/hydroflow/issues/1356)

### Commit Details
### Pre-Move Commit Details

<csr-read-only-do-not-edit/>

Expand Down Expand Up @@ -111,7 +111,7 @@
- <csr-id-6e571726ff40818fbe9bbe9923511877c20fb243/> add API to get the cluster ID of the current node
feat(hydroflow_plus): add API to get the cluster ID of the current node

### Commit Statistics
### Pre-Move Commit Statistics

<csr-read-only-do-not-edit/>

Expand All @@ -120,7 +120,7 @@
- 2 commits were understood as [conventional](https://www.conventionalcommits.org).
- 2 unique issues were worked on: [#1194](https://github.com/hydro-project/hydroflow/issues/1194), [#1238](https://github.com/hydro-project/hydroflow/issues/1238)

### Commit Details
### Pre-Move Commit Details

<csr-read-only-do-not-edit/>

Expand All @@ -147,7 +147,7 @@
for having developers run the optimizer during deployment as well in
case it changes the network topology.

### Commit Statistics
### Pre-Move Commit Statistics

<csr-read-only-do-not-edit/>

Expand All @@ -156,7 +156,7 @@
- 2 commits were understood as [conventional](https://www.conventionalcommits.org).
- 2 unique issues were worked on: [#1100](https://github.com/hydro-project/hydroflow/issues/1100), [#1101](https://github.com/hydro-project/hydroflow/issues/1101)

### Commit Details
### Pre-Move Commit Details

<csr-read-only-do-not-edit/>

Expand All @@ -181,7 +181,7 @@
- <csr-id-eb34ccd13f56e1d07cbae35ead79daeb3b9bad20/> use an IR before lowering to Hydroflow
Makes it possible to write custom optimization passes.

### Commit Statistics
### Pre-Move Commit Statistics

<csr-read-only-do-not-edit/>

Expand All @@ -190,7 +190,7 @@
- 2 commits were understood as [conventional](https://www.conventionalcommits.org).
- 2 unique issues were worked on: [#1070](https://github.com/hydro-project/hydroflow/issues/1070), [#1080](https://github.com/hydro-project/hydroflow/issues/1080)

### Commit Details
### Pre-Move Commit Details

<csr-read-only-do-not-edit/>

Expand Down Expand Up @@ -232,15 +232,15 @@
- <csr-id-53d7aee8dcc574d47864ec89bfea30a82eab0ee7/> improve Rust API for defining services
- <csr-id-c50ca121b6d5e30dc07843f82caa135b68626301/> split Rust core from Python bindings

### Commit Statistics
### Pre-Move Commit Statistics

<csr-read-only-do-not-edit/>

- 11 commits contributed to the release over the course of 43 calendar days.
- 9 commits were understood as [conventional](https://www.conventionalcommits.org).
- 6 unique issues were worked on: [#1013](https://github.com/hydro-project/hydroflow/issues/1013), [#1056](https://github.com/hydro-project/hydroflow/issues/1056), [#986](https://github.com/hydro-project/hydroflow/issues/986), [#987](https://github.com/hydro-project/hydroflow/issues/987), [#995](https://github.com/hydro-project/hydroflow/issues/995), [#996](https://github.com/hydro-project/hydroflow/issues/996)

### Commit Details
### Pre-Move Commit Details

<csr-read-only-do-not-edit/>

Expand Down

0 comments on commit c41787f

Please sign in to comment.