docs: update release process (#1758)

update release process
cosmos · Apr 4, 2024 · e57ec77 · e57ec77
1 parent 84199d7
commit e57ec77
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -19,7 +19,7 @@
 
 Check out the [changelog](https://github.com/cosmos/interchain-security/blob/<v*.*.*>/CHANGELOG.md) for a list of relevant changes or [compare all changes](https://github.com/cosmos/interchain-security/compare/release/<v-last>...<v*.*.*>) from last release.
 
-<!-- Add the following line for major releases -->
+<!-- Add the following line for major or minor releases -->
 Refer to the [upgrading guide](https://github.com/cosmos/interchain-security/blob/release/<v*.x>/UPGRADING.md) when migrating from `<v-last.x>` to `<v*.x>`.
 
 ** REMOVE THE LINE BELOW TO ENABLE THE MARKDOWN LINK CHECKER FOR RELEASE **

diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
@@ -12,6 +12,18 @@ This document outlines the release process for Interchain Security (ICS).
 
 For details on ICS releases, see [RELEASES.md](./RELEASES.md).
 
+The procedure of cutting a major or minor release consist of the following steps:
+
+- Create a new version section in the `CHANGELOG.md` (follow the procedure described [below](#changelog))
+- Create release notes, in `RELEASE_NOTES.md`, highlighting the new features and changes in the version. 
+  This info will be used to update the release notes when cutting the final release. 
+  > Note: release candidates do not need to have releases (tags are sufficient)
+- **(Only for major or minor releases)** Verify that the `UPGRADING.md` file is up 
+  to date and contains all the necessary information for upgrading to the new version.
+- Create a new annotated git tag in the release branch (follow the [Tagging Procedure](#tagging-procedure)).
+- **(Only for final releases)** Once the tag is created, use the GitHub interface 
+  to create a release and update the release notes with the information in `RELEASE_NOTES.md`.
+
 ## Changelog
 
 For PRs that are changing production code, please add a changelog entry in `.changelog` (for details, see [contributing guidelines](./CONTRIBUTING.md#changelog)). 
@@ -65,6 +77,7 @@ Before cutting a _**release candidate**_ (e.g., `v3.3.0-rc0`), the following ste
     ```md
     *December 5, 2023*
     ```
+    > Note: If necessary, more information can be added to the summary, but at least the date needs to be there.
 - update `CHANGELOG.md`, i.e.,
     ```bash
     unclog build > CHANGELOG.md