release-1.9.0

CHANGELOG.md

@@ -7,6 +7,8 @@ project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [v1.9.0]
+
 ### BREAKING CHANGES
 
 - Now uses Node version 16.19.0
@@ -148,7 +150,8 @@ project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/nasa/cumulus-ecs-task/compare/v1.8.0...HEAD
+[Unreleased]: https://github.com/nasa/cumulus-ecs-task/compare/v1.9.0...HEAD
+[v1.9.0]: https://github.com/nasa/cumulus-ecs-task/compare/v1.8.0...v1.9.0
 [v1.8.0]: https://github.com/nasa/cumulus-ecs-task/compare/v1.7.0...v1.8.0
 [v1.7.0]: https://github.com/nasa/cumulus-ecs-task/compare/v1.6.0...v1.7.0
 [v1.6.0]: https://github.com/nasa/cumulus-ecs-task/compare/v1.5.1...v1.6.0

README.md

@@ -139,28 +139,51 @@ sudo start ecs
 
 ## Create a release
 
-To create a release, first make sure the [CHANGELOG.md](CHANGELOG.md) file is
-updated with all the changes made.
+### 1. Create a branch for the new release
 
-Next, bump the version and the changes will automatically be released upon merge
-to master.
+#### From Master
 
-```bash
-npm version <major|minor|patch|specific version>
+Create a branch titled `release-MAJOR.MINOR.PATCH` for the release.
+
+```shell
+    git checkout -b release-MAJOR.MINOR.PATCH
+
+e.g.:
+    git checkout -b release-1.1.0
 ```
 
-Create the build
+### 2. Update the version number
 
 ```bash
-npm run build
+npm version <major|minor|patch|specific version> --no-git-tag-version
 ```
 
-Release to Docker Hub
+### 3. Update CHANGELOG.md
+
+Update the `CHANGELOG.md`. Put a header under the `Unreleased` section with the new version number and the date.
+
+Add a link reference for the github "compare" view at the bottom of the `CHANGELOG.md`, following the existing pattern.
+This link reference should create a link in the CHANGELOG's release header to changes in the corresponding release.
+
+Commit and push these changes.
+
+### 4. Create a pull request against the minor version branch
+
+### 5. Create a git tag for the release
+
+Create and push a new git tag:
 
 ```bash
-npm run release
+    git tag -a vMAJOR.MINOR.PATCH -m "Release MAJOR.MINOR.PATCH"
+    git push origin vMAJOR.MINOR.PATCH
+
+e.g.:
+    git tag -a v1.1.0 -m "Release 1.1.0"
+    git push origin v1.1.0
 ```
 
+Upon the PR is merged to master, the npm package and docker image will be automatically published.
+
 ## Contributing
 
 See the [CONTRIBUTING.md](CONTRIBUTING.md) file.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/cumulus-ecs-task",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Run lambda functions in ECS",
   "main": "index.js",
   "bin": {