Add RELEASE.md

RELEASE.md

@@ -0,0 +1,66 @@
+# `che-operator` release process
+
+## 1. Release files
+
+```bash
+./make-release.sh <RELEASE_VERSION>
+```
+
+## 2. Testing release on crc
+
+Start a cluster using `cluster-bot` application.
+
+To be able to test update it is needed to created some user before. Login as `kubeadmin`. At the middle of the dashboard click `Update OAuth configuration`. Then `Identity providers` -> `Add` -> `HTPassword` and upload a htpassword file (can be created with HTPassword utility). Login using HTPassword, logout and login again as `kubeadmin`. Go to `kube:admin` menu -> `Copy Login Command` -> `Display Token` and launch to showing command in the terminal. Now it is possible to test update:
+
+```bash
+olm/testUpdates.sh openshift stable
+```
+
+Open Eclipse Che dashboard in the anonymous to validate that the correct version is installed and workspace can be created:
+
+```bash
+echo http://$(kubectl get ingress -n che | grep ^che | awk -F ' ' '{ print $2 }')
+```
+
+## 3. Testing release on minikube
+
+Run script to test updates:
+
+```bash
+olm/testUpdates.sh kubernetes stable
+```
+
+Open Eclipse Che dashboard to validate that the correct version is installed and workspace can be created:
+
+```bash
+xdg-open http://$(kubectl get ingress -n che | grep ^che | awk -F ' ' '{ print $2 }')
+```
+
+## 4. Testing release on minishift
+
+Login to local minishift cluster:
+
+```bash
+oc login <LOCAL_MINISHIFT_CLUSTER_ADDRESS>
+```
+
+Install the previous version of Eclipse Che:
+
+```bash
+chectl server:start --platform=minikube  --installer=operator --che-operator-image=quay.io/eclipse/che-operator:<PREVIOUS_RELEASE_VERSION>
+```
+
+Update Eclipse Che to the latest version. Validate that the correct version is installed and workspace can be created:
+
+```bash
+chectl server:update --platform=minishift  --installer=operator
+xdg-open http://$(kubectl get ingress -n che | grep ^che | awk -F ' ' '{ print $2 }')
+```
+
+## 5. Prepare community operator PR
+
+```bash
+olm/prepare-community-operators-update.sh
+```
+
+TODO automate creating PRs

make-release.sh

@@ -0,0 +1,232 @@
+#!/bin/bash
+#
+# Copyright (c) 2019 Red Hat, Inc.
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+# Contributors:
+#   Red Hat, Inc. - initial API and implementation
+
+set -e
+
+init() {
+  RED='\e[31m'
+  NC='\e[0m'
+  YELLOW='\e[33m'
+  GREEN='\e[32m'
+}
+
+check() {
+  echo -e $RED"##############################################"
+  echo -e $RED"  This is a draft version of release script."
+  echo -e $RED"  It is needed to check all steps manually."
+  echo -e $RED"##############################################"$NC
+
+
+  if [ $# -ne 1 ]; then
+    printf "%bError: %bWrong number of parameters.\nUsage: ./make-release.sh <version>\n" "${RED}" "${NC}"
+    exit 1
+  fi
+
+  [ -z "$QUAY_USERNAME" ] && echo -e $RED"QUAY_USERNAME is not set"$NC && exit 1
+  [ -z "$QUAY_PASSWORD" ] && echo -e $RED"QUAY_PASSWORD is not set"$NC && exit 1
+  command -v operator-courier >/dev/null 2>&1 || { echo -e $RED"operator-courier is not installed. Aborting."$NC; exit 1; }
+  command -v operator-sdk >/dev/null 2>&1 || { echo -e $RED"operator-sdk is not installed. Aborting."$NC; exit 1; }
+
+  local operatorVersion=$(operator-sdk version)
+  [[ ! $operatorVersion =~ .*v0.10.0.* ]] || { echo -e $RED"operator-sdk v0.10.0 is required"$NC; exit 1; }
+}
+
+ask() {
+  while true; do
+    echo -e $GREEN$@$NC" (Y)es or (N)o"
+    read -r yn
+    case $yn in
+      [Yy]* ) return 0;;
+      [Nn]* ) return 1;;
+      * ) echo "Please answer (Y)es or (N)o.";;
+    esac
+  done
+}
+
+resetLocalChanges() {
+  set +e
+  ask "1. Reset local changes?"
+  result=$?
+  set -e
+
+  if [[ $result == 0 ]]; then
+    git fetch ${GIT_REMOTE_UPSTREAM}
+    git pull ${GIT_REMOTE_UPSTREAM} master
+  elif [[ $result == 1 ]]; then
+    echo -e $YELLOW"> SKIPPED"$NC
+  fi
+}
+
+createLocalBranch() {
+  set +e
+  ask "2. Create local '$RELEASE' branch?"
+  result=$?
+  set -e
+
+  if [[ $result == 0 ]]; then
+    git checkout -b $RELEASE
+  elif [[ $result == 1 ]]; then
+    echo -e $YELLOW"> SKIPPED"$NC
+  fi
+}
+
+releaseOperatorCode() {
+  set +e
+  ask "3. Release operator code?"
+  result=$?
+  set -e
+
+  if [[ $result == 0 ]]; then
+    local defaultsgo=$BASE_DIR/pkg/deploy/defaults.go
+
+    echo "3.1 Launch 'release-operator-code.sh' script"
+    . ${BASE_DIR}/release-operator-code.sh $RELEASE
+
+    echo "3.2 Validate pkg/deploy/defaults.go"
+    grep -q "defaultCheServerImageTag            = \""$RELEASE"\"" $defaultsgo
+    grep -q "defaultDevfileRegistryUpstreamImage = \"quay.io/eclipse/che-devfile-registry:"$RELEASE"\"" $defaultsgo
+    grep -q "defaultPluginRegistryUpstreamImage  = \"quay.io/eclipse/che-plugin-registry:"$RELEASE"\"" $defaultsgo
+    grep -q "defaultKeycloakUpstreamImage        = \"quay.io/eclipse/che-keycloak:"$RELEASE"\"" $defaultsgo
+  elif [[ $result == 1 ]]; then
+    echo -e $YELLOW"> SKIPPED"$NC
+  fi
+}
+
+commitDefaultsGoChanges() {
+  set +e
+  ask "4. Commit changes?"
+  result=$?
+  set -e
+
+  if [[ $result == 0 ]]; then
+    git commit -am "Update defaults tags to "$RELEASE --singoff
+  elif [[ $result == 1 ]]; then
+    echo -e $YELLOW"> SKIPPED"$NC
+  fi
+}
+
+pushImage() {
+  set +e
+  ask "5. Push image to quay.io?"
+  result=$?
+  set -e
+
+  if [[ $result == 0 ]]; then
+    docker login quay.io
+    docker push quay.io/eclipse/che-operator:$RELEASE
+  elif [[ $result == 1 ]]; then
+    echo -e $YELLOW"> SKIPPED"$NC
+  fi
+}
+
+releaseOlmFiles() {
+  set +e
+  ask "6. Release OLM files?"
+  result=$?
+  set -e
+
+  if [[ $result == 0 ]]; then
+    echo "6.1 Launch 'olm/release-olm-files.sh' script"
+    . $BASE_DIR/olm/release-olm-files.sh $RELEASE
+
+    local openshift=$BASE_DIR/olm/eclipse-che-preview-openshift/deploy/olm-catalog/eclipse-che-preview-openshift
+    local kubernetes=$BASE_DIR/olm/eclipse-che-preview-kubernetes/deploy/olm-catalog/eclipse-che-preview-kubernetes
+
+    echo "6.2 Validate files"
+    grep -q "currentCSV: eclipse-che-preview-openshift.v"$RELEASE $openshift/eclipse-che-preview-openshift.package.yaml
+    grep -q "currentCSV: eclipse-che-preview-kubernetes.v"$RELEASE $kubernetes/eclipse-che-preview-kubernetes.package.yaml
+    grep -q "version: "$RELEASE $openshift/$RELEASE/eclipse-che-preview-openshift.v$RELEASE.clusterserviceversion.yaml
+    grep -q "version: "$RELEASE $kubernetes/$RELEASE/eclipse-che-preview-kubernetes.v$RELEASE.clusterserviceversion.yaml
+    test -f $kubernetes/$RELEASE/eclipse-che-preview-kubernetes.crd.yaml
+    test -f $openshift/$RELEASE/eclipse-che-preview-openshift.crd.yaml
+
+    echo "6.3 It is needed to check diff files manully"
+    echo $openshift/$RELEASE/eclipse-che-preview-openshift.v$RELEASE.clusterserviceversion.yaml.diff
+    echo $kubernetes/$RELEASE/eclipse-che-preview-kubernetes.v$RELEASE.clusterserviceversion.yaml.diff
+    echo $openshift/$RELEASE/eclipse-che-preview-openshift.crd.yaml.diff
+    echo $kubernetes/$RELEASE/eclipse-che-preview-kubernetes.crd.yaml.diff
+    read -p "Press enter to continue"
+  elif [[ $result == 1 ]]; then
+    echo -e $YELLOW"> SKIPPED"$NC
+  fi
+}
+
+commitOlmChanges() {
+  set +e
+  ask "7. Commit changes?"
+  result=$?
+  set -e
+
+  if [[ $result == 0 ]]; then
+    git add -A
+    git commit -m "Release OLM files to "$RELEASE --singoff
+  elif [[ $result == 1 ]]; then
+    echo -e $YELLOW"> SKIPPED"$NC
+  fi
+}
+
+pushOlmFiles() {
+  set +e
+  ask "8. Push OLM files to quay.io?"
+  result=$?
+  set -e
+
+  if [[ $result == 0 ]]; then
+    . $BASE_DIR/olm/push-olm-files-to-quay.sh
+
+    read -p "Validate RELEASES page on quay.io. Press enter to open the browser"
+    xdg-open https://quay.io/application/eclipse-che-operator-kubernetes/eclipse-che-preview-kubernetes
+
+    read -p "Validate RELEASES page on quay.io. Press enter to open the browser"
+    xdg-open https://quay.io/application/eclipse-che-operator-openshift/eclipse-che-preview-openshift
+
+    read -p "Press enter to continue"
+  elif [[ $result == 1 ]]; then
+    echo -e $YELLOW"> SKIPPED"$NC
+  fi
+}
+
+pushChanges() {
+  set +e
+  ask "9. Push changes?"
+  result=$?
+  set -e
+
+  if [[ $result == 0 ]]; then
+    git push origin $RELEASE
+    git tag -a $RELEASE
+    git push --tags origin
+  elif [[ $result == 1 ]]; then
+    echo -e $YELLOW"> SKIPPED"$NC
+  fi
+}
+
+run() {
+  RELEASE="$1"
+  GIT_REMOTE_UPSTREAM="git@github.com:eclipse/che-operator.git"
+  CURRENT_DIR=$(pwd)
+  BASE_DIR=$(cd "$(dirname "$0")"; pwd)
+
+  resetLocalChanges
+  createLocalBranch
+  releaseOperatorCode
+  commitDefaultsGoChanges
+  pushImage
+  releaseOlmFiles
+  commitOlmChanges
+  pushOlmFiles
+  pushChanges
+}
+
+init "$@"
+check "$@"
+run "$@"

olm/release-olm-files.sh

@@ -77,5 +77,9 @@ do
   diff -u "${packageFolderPath}/${lastPackagePreReleaseVersion}/${packageName}.v${lastPackagePreReleaseVersion}.clusterserviceversion.yaml" \
   "${packageFolderPath}/${RELEASE}/${packageName}.v${RELEASE}.clusterserviceversion.yaml" \
   > "${packageFolderPath}/${RELEASE}/${packageName}.v${RELEASE}.clusterserviceversion.yaml.diff" || true
+
+  diff -u "${packageFolderPath}/${lastPackagePreReleaseVersion}/${packageName}.crd.yaml" \
+  "${packageFolderPath}/${RELEASE}/${packageName}.crd.yaml" \
+  > "${packageFolderPath}/${RELEASE}/${packageName}.crd.yaml.diff" || true
 done
 cd "${CURRENT_DIR}"