Skip to content

Commit

Permalink
Small improvements to RELEASE.md (#4447)
Browse files Browse the repository at this point in the history
* Update RELEASE.md to explicitly list the files that have version numbers hardcoded that need to be updated.

* Followup to review comments

* Followup to review comments.

* Followup to review comments.

* Fixed cut&paste.

* Cosmetic change.

* Tweak verbiage.

* Update RELEASE.md

* Update to major.minor.patch pattern for versions.

* Followup to review comments.

* Fixed conflict markers left over.

---------

Co-authored-by: Stan Brubaker <120737309+stanbrub@users.noreply.github.com>
  • Loading branch information
jcferretti and stanbrub authored Sep 6, 2023
1 parent fa4fee9 commit 746948e
Showing 1 changed file with 33 additions and 13 deletions.
46 changes: 33 additions & 13 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ $ git commit --allow-empty -m "Cut for X.Y.Z"
#### Procedure for patch releases

For patch releases, typically the branch will be based off of the previous release tag, and not `upstream/main`, and the necessary patch fixes can be cherry-picked from the `upstream/main` branch.
The patch release manager is also responsible for bumping the patch version numbers as appropriate.
The patch release manager is also responsible for bumping the patch version numbers as appropriate (note comment block on the list of commands
below).

Here is an example going from `X.Y.0` to `X.Y.1`:

Expand All @@ -101,19 +102,11 @@ $ git fetch upstream
$ git checkout vX.Y.0
$ git checkout -b release/vX.Y.1
$ git cherry-pick <...>
# Edit files, updating from `X.Y.0` to `X.Y.1`, and git add them. Currently the list is:
#
# * authorization-codegen/protoc-gen-contextual-auth-wiring
# * authorization-codegen/protoc-gen-service-auth-wiring
# * buildSrc/src/main/groovy/io.deephaven.common-conventions.gradle
# * py/client-ticking/README.md
# * py/client-ticking/setup.py
# * py/client/README.md
# * py/client/pydeephaven/__init__.py
# * py/client/setup.py
# * py/embedded-server/deephaven_server/__init__.py
# * py/server/deephaven/__init__.py
# * R/rdeephaven/DESCRIPTION
# Edit files, updating from X.Y.0 to X.Y.1, and git add them.
#
# Look in the last section "Version bump in preparation of next release" for a list of
# files to update to the right version you are producing.
#
# See https://github.com/deephaven/deephaven-core/issues/3466 for future improvements to this process.
$ ...
Expand Down Expand Up @@ -244,6 +237,33 @@ Ping team, ping community, ping friends - the latest Deephaven has been released
The release branches serve a purpose for kicking off CI jobs, but aren't special in other ways.
Sometime after a release, old release branches can be safely deleted.

### 15. Version bump in preparation of the next release.

Say we just did release `0.31.0`. The next expected release is `0.32.0` We update the repository with a bump to all files that
mention the version explicitly. These files are listed below:

```
#
# Edit files for version change, updating from 0.31.0 to 0.32.0
#
authorization-codegen/protoc-gen-contextual-auth-wiring
authorization-codegen/protoc-gen-service-auth-wiring
buildSrc/src/main/groovy/io.deephaven.common-conventions.gradle
py/client-ticking/README.md
py/client-ticking/setup.py
py/client/README.md
py/client/pydeephaven/__init__.py
py/client/setup.py
py/embedded-server/deephaven_server/__init__.py
py/server/deephaven/__init__.py
R/rdeephaven/DESCRIPTION
```

This leaves the files "ready" for the next regular release, and also ensures any build done from
a developer for testing of latest is not confused with the code just released.

In the case of a patch release these would need to be updated to a different version, like from `0.31.0` to `0.31.1`.

## External dependencies

There are a few external dependencies that Deephaven manages, but they have separate release lifecycles that don't directly impact the release of the other artifacts mentioned earlier.
Expand Down

0 comments on commit 746948e

Please sign in to comment.