chore(docs): Improve release process docs (#436)

* chore(docs): Improve release process docs

* also mention help docs and release workflow

README.md

@@ -21,22 +21,34 @@ when the `develop` branch is merged into `master`.
 
 To make releasing easier two scripts are utilized in the steps below.
 
-1. `$ .github/release-vector-version.sh`
-    - This queries [vectordotdev/vector](https://github.com/vectordotdev/vector)
-for the latest release and updates the `vector` chart's default image.
-    - This is convenient when updating the chart after a Vector release.
-
-2. Commit the changes generated from step 1. This needs to be a
-[conventional commit](https://www.conventionalcommits.org/).
-    - E.g. "feat(vector): Bump Vector to v0.29.0"
-
-3. `$ .github/release-changelog.sh`
-    - This pulls the current `vector` chart version and uses `git-cliff` to update
-the [CHANGELOG.md](CHANGELOG.md). Run this to generate the final commit merged into
-`develop` before merging `develop` into `master`.
-    - This script requires [`yq`](https://github.com/mikefarah/yq) and
-[`git-cliff`](https://github.com/orhun/git-cliff) to be installed.
-
-4. Commit the changes generated from step 1. This needs to be a
-[conventional commit](https://www.conventionalcommits.org/).
-    - E.g. "feat(vector): Regenerate CHANGELOG"
+1. Run `$ .github/release-vector-version.sh`
+   - Update Helm docs by running `helm-docs`
+   - Commit the changes generated from step 1. This needs to be a
+      [conventional commit](https://www.conventionalcommits.org/).
+     - E.g. "feat(vector): Bump Vector to v0.29.0"
+     - Submit a PR with the changes.
+   - Notes:
+     - This queries [vectordotdev/vector](https://github.com/vectordotdev/vector)
+     for the latest release and updates the `vector` chart's default image.
+     - This is convenient when updating the chart after a Vector release.
+     - On macOS, install `gsed`
+
+2. Run `$ .github/release-changelog.sh`
+   - Commit the changes generated from step 1. This needs to be a
+      [conventional commit](https://www.conventionalcommits.org/).
+      - E.g. "feat(vector): Regenerate CHANGELOG"
+   - Submit a PR with the changes.
+   - Notes:
+     - This pulls the current `vector` chart version and uses `git-cliff` to update
+       the [CHANGELOG.md](CHANGELOG.md). Run this to generate the final commit merged into
+       `develop` before merging `develop` into `master`.
+     - This script requires [`yq`](https://github.com/mikefarah/yq) and
+       [`git-cliff`](https://github.com/orhun/git-cliff) to be installed.
+
+3. To kick off the [release workflow](https://github.com/vectordotdev/helm-charts/actions/workflows/release.yaml):
+ ```
+   git switch master
+   git pull
+   git merge develop
+   git push
+```