Add Release guide (flyteorg#1220)

* Milestone 0.15.0 release (flyteorg#1218) * Milestone 0.15.0 release Signed-off-by: Haytham Abuelfutuh <[email protected]> * Update docs version Signed-off-by: Haytham Abuelfutuh <[email protected]> * Update flytetools image sha Signed-off-by: Haytham Abuelfutuh <[email protected]> * Add bin/ to .gitignore Signed-off-by: Haytham Abuelfutuh <[email protected]> * v2 Signed-off-by: Haytham Abuelfutuh <[email protected]> * v3 Signed-off-by: Haytham Abuelfutuh <[email protected]> * v4 Signed-off-by: Haytham Abuelfutuh <[email protected]> * bump Signed-off-by: Haytham Abuelfutuh <[email protected]> Co-authored-by: HackMD <[email protected]>
palchicz · Jul 7, 2021 · f90e19c · f90e19c
1 parent a3f373b
commit f90e19c
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,24 @@
+# Release Process
+
+[![hackmd-github-sync-badge](https://hackmd.io/sVOAyv6LTwiQllQUctxP1w/badge)](https://hackmd.io/sVOAyv6LTwiQllQUctxP1w)
+
+## Resolve Issues
+1. Create [a new milestone](https://github.com/flyteorg/flyte/milestones) if one doesn't exist.
+1. Open [issues](https://github.com/flyteorg/flyte/issues) and filter by milestone and make sure they are either closed or moved over to the next milestone.
+## Update EndToEndTests
+1. Update [requirements](https://github.com/flyteorg/flytetools/blob/master/flytetester/requirements.txt#L1) to the desired (e.g. latest) [flytekit release](https://github.com/flyteorg/flytekit/releases).
+1. Build a docker image and push to ghcr.io/flyteorg
+   ```prompt
+   make -C flytetester docker_build_push
+   ```
+## Start a release PR
+1. Run [Generate Flyte Manifests workflow](https://github.com/flyteorg/flyte/actions/workflows/generate-flyte-manifest.yml). It’ll create a PR ([example](https://github.com/flyteorg/flyte/pull/888))
+1. Update [docs version](https://github.com/flyteorg/flyte/blob/master/rsts/conf.py#L28) to match the milestone version.
+1. Create a CHANGELOG file ([example](https://github.com/flyteorg/flyte/pull/888/files#diff-0c33dda4ecbd7e1116ddce683b5e143d85b22e43223ca258ecc571fb3b240a57))
+1. Update [the sha](https://github.com/flyteorg/flyte/blob/master/end2end/tests/endtoend.yaml#L14) with the latest image released in #2
+1. Wait for endtoend tests to finish then Merge PR.
+## Create a release
+1. Run [Create Flyte Release workflow](https://github.com/flyteorg/flyte/actions/workflows/create-release.yml):
+   It will create a tag and then publish all deployment manifest in github release and will create a discussion thread in github release 
+1. Close the milestone
+1. Ping #core (slack channel) to: Send announcements about the milestone with the contents of the CHANGELOG to all social channels..