update docs

Signed-off-by: Jordan Dubrick <[email protected]>

Author: Jdubrick

README.md

@@ -23,6 +23,13 @@ Releases are available on [GitHub](https://github.com/devfile/registry-operator/
 
 For more updates on releases, please join our [communication channels](https://devfile.io/docs/2.2.2/community#getting-involved).
 
+## Preparing Releases
+A script has been created to make the release process more efficient. This script takes care of all changes to version numbers in all necessary files. Additionally this script opens the initial PR to devfile/registry-operator. The release engineer will be responsible for running this script with the instructions below.
+
+1. Navigate to main branch of your forked registry-operator repository.
+2. Run `make release new-version=x.x.x` where x.x.x is the version you are trying to cut.
+3. Edit the PR opened by the script on devfile/registry-operator to include a proper description.
+
 ## Issue Tracking
 
 Issue tracking repo: https://github.com/devfile/api with label area/registry

make-release.sh

@@ -72,10 +72,10 @@ checkoutToReleaseBranch() {
   echo "[INFO] Checking out to $SCHEMA_VERSION branch."
   if git ls-remote -q --heads | grep -q $SCHEMA_VERSION ; then
     echo "[INFO] $SCHEMA_VERSION exists."
-    resetChanges $SCHEMA_VERSION --- commented out so it doesnt delete my work when testing
+    resetChanges $SCHEMA_VERSION
   else
     echo "[INFO] $SCHEMA_VERSION does not exist. Will create a new one from main."
-    resetChanges release-automation --- commented out so it doesnt delete my work when testing #change release-automation to main after testing
+    resetChanges release-automation #change release-automation to main after testing
     git push origin release-automation:$SCHEMA_VERSION
   fi
   git checkout -B $SCHEMA_VERSION
@@ -134,19 +134,18 @@ verifyReleaseBranch() {
 
 createPullRequest(){
   echo "[INFO] Creating a PR"
-  hub pull-request --base jdubrick:${RELEASE_BRANCH} --head ${SCHEMA_VERSION} -m "$1"
+  hub pull-request --base jdubrick:${RELEASE_BRANCH} --head ${SCHEMA_VERSION} -m "$1" #jdubrick changes to devfile
 }
 
 main(){
+  #setUpstream -- LEAVE COMMENTED AS THIS WILL SET MY ORIGIN TO DEVFILE
   checkoutToReleaseBranch
   updateVersionNumbers
   exportEnvironmentVariables
   make bundle
   commitChanges "chore(release): release version ${SCHEMA_VERSION}"
   verifyReleaseBranch
   createPullRequest "v${SCHEMA_VERSION} Release"
-  
-  #setUpstream -- LEAVE COMMENTED AS THIS WILL SET MY ORIGIN TO DEVFILE
 }
 
 main