@rancher/shell 1.2.3 → 2.0.1

package/scripts/extension/parse-tag-name

@@ -4,8 +4,8 @@ GITHUB_RELEASE_TAG=$1
 GITHUB_RUN_ID=$2
 GITHUB_WORKFLOW_TYPE=$3
 
-# Check packages for released tag name
-if [[ "${GITHUB_WORKFLOW_TYPE}" == "container" ]]; then
+# Ensure "catalog" workflow release tag name does not match a pkg/<pkg-name>
+if [[ "${GITHUB_WORKFLOW_TYPE}" == "catalog" ]]; then
   for d in pkg/*/ ; do
     pkg=$(basename $d)
 
@@ -19,7 +19,7 @@ if [[ "${GITHUB_WORKFLOW_TYPE}" == "container" ]]; then
     fi
   done
 else
-  # Check base extension name for tag name
+  # Ensure "charts" workflow release tag name does not match the root <pkg-name>
   BASE_EXT=$(jq -r .name package.json)
   EXT_VERSION=$(jq -r .version package.json)
 
@@ -27,4 +27,4 @@ else
     echo -e "tag: ${GITHUB_RELEASE_TAG}"
     gh run cancel ${GITHUB_RUN_ID}
   fi
-fi
+fi

package/scripts/extension/publish

@@ -17,12 +17,13 @@ IMAGE_PREFIX="ui-extension-"
 FORCE="false"
 GITHUB_BUILD="true"
 GITHUB_RELEASE_TAG=""
+PODMAN_CONTAINER="false"
 
 GITHUB_SOURCE=$(git config --get remote.origin.url | sed -e 's/^git@.*:\([[:graph:]]*\).git/\1/')
 GITHUB_BRANCH="main"
 
 usage() {
-  echo "Usage: $0 [<options>] [plugins]"
+  echo "Usage: $0 [<options>] [extensions]"
   echo " options:"
   echo "  -s <repo>    Specify destination GitHub repository (org/name) - defaults to the git origin"
   echo "  -b <branch>  Specify destination GitHub branch"
@@ -33,10 +34,11 @@ usage() {
   echo "  -r <name>    Specify destination container registry for built images"
   echo "  -o <name>    Specify destination container registry organization for built images"
   echo "  -i <prefix>  Specify prefix for the built container image (default: 'ui-extension-')"
+  echo "  -l           Specify Podman container build"
   exit 1
 }
 
-while getopts "hvr:o:pi:fcb:t:s:" opt; do
+while getopts "hvr:o:pi:fcb:t:s:l" opt; do
   case $opt in
     h)
       usage
@@ -70,6 +72,9 @@ while getopts "hvr:o:pi:fcb:t:s:" opt; do
     t)
       GITHUB_RELEASE_TAG="${OPTARG}"
       ;;
+    l)
+      PODMAN_CONTAINER="true"
+      ;;
     *)
       usage
       ;;
@@ -81,7 +86,7 @@ shift $((OPTIND-1))
 PLUGINS=( "$@" )
 BUILT="false"
 
-echo -e "${CYAN}${BOLD}Publishing UI Plugins${RESET}"
+echo -e "${CYAN}${BOLD}Publishing UI Extensions${RESET}"
 
 pushd ${BASE_DIR} > /dev/null
 
@@ -126,7 +131,11 @@ fi
 
 COMMANDS=("node" "jq" "yq" "git" "helm" "yarn")
 if [ "${GITHUB_BUILD}" == "false" ]; then
-  COMMANDS+=("docker")
+  if [ "${PODMAN_CONTAINER}" == "true" ]; then
+    COMMANDS+=("podman")
+  else
+    COMMANDS+=("docker")
+  fi
 fi
 
 HAVE_COMMANDS="true"
@@ -172,10 +181,12 @@ if [ "${GITHUB_BUILD}" == "false" ]; then
     exit 1
   fi
 
-  docker images > /dev/null
-  if [ $? -ne 0 ]; then
-    echo "docker is not running - this is required to build container images for the UI Plugins"
-    exit 1
+  if [ "${PODMAN_CONTAINER}" == "false" ]; then
+    docker images > /dev/null
+    if [ $? -ne 0 ]; then
+      echo "docker is not running - this is required to build container images for the UI Extensions"
+      exit 1
+    fi
   fi
 fi
 
@@ -218,7 +229,7 @@ for d in pkg/*/ ; do
       continue
     fi
 
-    echo -e "${CYAN}${BOLD}Building plugin: ${pkg} (${PKG_VERSION}) ${RESET}"
+    echo -e "${CYAN}${BOLD}Building extension: ${pkg} (${PKG_VERSION}) ${RESET}"
 
     echo "Package version: ${PKG_VERSION}"
     echo "Package folder:  ${PKG_NAME}"
@@ -226,10 +237,10 @@ for d in pkg/*/ ; do
     # --------------------------------------------------------------------------------
     # Build the plugin from source
     # --------------------------------------------------------------------------------
-    echo -e "${CYAN}Building plugin from source code${RESET}"
+    echo -e "${CYAN}Building extension from source code${RESET}"
     FORCE_COLOR=1 yarn build-pkg $pkg | cat
 
-    echo -e "${CYAN}Adding plugin code ...${RESET}"
+    echo -e "${CYAN}Adding extension code ...${RESET}"
 
     EXT_FOLDER=${BASE_DIR}/extensions/${pkg}/${PKG_VERSION}
     PKG_DIST="${BASE_DIR}/dist-pkg/${PKG_NAME}"
@@ -354,8 +365,8 @@ if [ "${GITHUB_BUILD}" == "false" ]; then
   echo -e "${CYAN}Base extension: ${BASE_EXT}${RESET}"
   echo -e "${CYAN}Extension version: ${EXT_VERSION}${RESET}"
 
-  # Build the docker image
-  ${SCRIPT_DIR}/bundle ${BASE_EXT} ${EXT_VERSION} ${REGISTRY} ${REGISTRY_ORG} ${IMAGE_PREFIX} ${PUSH}
+  # Build the container image
+  ${SCRIPT_DIR}/bundle "${BASE_EXT}" "${EXT_VERSION}" "${REGISTRY}" "${REGISTRY_ORG}" "${IMAGE_PREFIX}" "${PUSH}" "${PODMAN_CONTAINER}"
 else
   rm -rf ${CHART_TEMPLATE}
 fi
@@ -386,5 +397,5 @@ fi
 rm -rf ${CHART_TMP}
 
 if [ "${GITHUB_BUILD}" == "false" ]; then
-  rm -rf ${TMP}
+  rm -rf ${TMP} ${ASSETS} ${CHARTS} ${BASE_DIR}/extensions ${BASE_DIR}/dist-pkg ${ROOT_INDEX}
 fi

package/scripts/publish-shell.sh

@@ -8,6 +8,8 @@ BASE_DIR="$(
 SHELL_DIR=$BASE_DIR/shell/
 TMP_DIR=$BASE_DIR/tmp
 PUBLISH_ARGS="--no-git-tag-version --access public $PUBLISH_ARGS"
+FORCE_PUBLISH_TO_NPM="false"
+DEFAULT_YARN_REGISTRY="https://registry.npmjs.org"
 
 if [ ! -d "${BASE_DIR}/node_modules" ]; then
   echo "You need to run 'yarn install' first"
@@ -16,6 +18,14 @@ fi
 
 echo "Publishing Shell Packages"
 
+if [ "$1" == "--npm" ]; then
+  FORCE_PUBLISH_TO_NPM="true"
+fi
+
+if [ "$FORCE_PUBLISH_TO_NPM" == "true" ]; then
+  export YARN_REGISTRY=$DEFAULT_YARN_REGISTRY
+fi
+
 # We use the version from the shell package for the creator packages
 # Need to copy them to a temporary location, so we can patch the version number
 # before publishing
@@ -79,7 +89,7 @@ function publish() {
   # Make a note of dependency versions, if required
   node ${SCRIPT_DIR}/record-deps.js
 
-  yarn publish . --new-version ${PKG_VERSION} ${PUBLISH_ARGS} --tag v1.2
+  yarn publish . --new-version ${PKG_VERSION} ${PUBLISH_ARGS}
   RET=$?
 
   popd >/dev/null

package/scripts/serve-pkgs

@@ -51,8 +51,6 @@ if (process.env.PORT) {
 
 const base = `http://127.0.0.1:${ port }`;
 
-console.log('');
-console.log(`Serving catalog on ${ base }`);
 console.log('');
 console.log(`Serving packages:`);
 console.log('');

package/scripts/test-plugins-build.sh

@@ -7,6 +7,9 @@ echo "Checking plugin build"
 SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 BASE_DIR="$( cd $SCRIPT_DIR && cd ../.. & pwd)"
 SHELL_DIR=$BASE_DIR/shell/
+SHELL_VERSION="99.99.99"
+DEFAULT_YARN_REGISTRY="https://registry.npmjs.org"
+VERDACCIO_YARN_REGISTRY="http://localhost:4873"
 
 echo ${SCRIPT_DIR}
 
@@ -66,21 +69,24 @@ else
   rm -rf ~/.config/verdaccio/storage/@rancher/*
 fi
 
-export YARN_REGISTRY=http://localhost:4873
+export YARN_REGISTRY=$VERDACCIO_YARN_REGISTRY
 export NUXT_TELEMETRY_DISABLED=1
 
 # Remove test package from previous run, if present
-rm -rf ${BASE_DIR}/pkg/test-pkg
+if [ $TEST_PERSIST_BUILD != "true" ]; then
+  echo "Removing folder ${BASE_DIR}/pkg/test-pkg"
+  rm -rf ${BASE_DIR}/pkg/test-pkg
+fi
 
 # We need to patch the version number of the shell, otherwise if we are running
 # with the currently published version, things will fail as those versions
 # are already published and Verdaccio will check, since it is a read-through cache
-sed -i.bak -e "s/\"version\": \"[0-9]*.[0-9]*.[0-9]*\",/\"version\": \"7.7.7\",/g" ${SHELL_DIR}/package.json
+sed -i.bak -e "s/\"version\": \"[0-9]*.[0-9]*.[0-9]*\(-alpha\.[0-9]*\|-release[0-9]*.[0-9]*.[0-9]*\|-rc\.[0-9]*\)\{0,1\}\",/\"version\": \"${SHELL_VERSION}\",/g" ${SHELL_DIR}/package.json
 rm ${SHELL_DIR}/package.json.bak
 
 # Same as above for Rancher Components
 # We might have bumped the version number but its not published yet, so this will fail
-sed -i.bak -e "s/\"version\": \"[0-9]*.[0-9]*.[0-9]*\",/\"version\": \"7.7.7\",/g" ${BASE_DIR}/pkg/rancher-components/package.json
+sed -i.bak -e "s/\"version\": \"[0-9]*.[0-9]*.[0-9]*\(-alpha\.[0-9]*\|-release[0-9]*.[0-9]*.[0-9]*\|-rc\.[0-9]*\)\{0,1\}\",/\"version\": \"${SHELL_VERSION}\",/g" ${BASE_DIR}/pkg/rancher-components/package.json
 
 # Publish shell
 echo "Publishing shell packages to local registry"
@@ -108,11 +114,12 @@ if [ "${SKIP_STANDALONE}" == "false" ]; then
   yarn install
 
   echo "Building skeleton app"
+
   FORCE_COLOR=true yarn build | cat
 
   # Package creator
   echo "Verifying package creator package"
-  yarn create @rancher/pkg test-pkg
+  yarn create @rancher/pkg test-pkg -i
 
   echo "Building test package"
   FORCE_COLOR=true yarn build-pkg test-pkg | cat
@@ -127,22 +134,91 @@ if [ "${SKIP_STANDALONE}" == "false" ]; then
   echo "Cleaning temporary dir"
   popd > /dev/null
 
-  rm -rf ${DIR}
+  if [ $TEST_PERSIST_BUILD != "true" ]; then
+    echo "Removing folder ${DIR}"
+    rm -rf ${DIR}
+  fi
 fi
 
 pushd $BASE_DIR
-pwd
-ls
 
 # Now try a plugin within the dashboard codebase
 echo "Validating in-tree package"
 
 yarn install
 
-rm -rf ./pkg/test-pkg
-yarn create @rancher/pkg test-pkg -t
+if [ $TEST_PERSIST_BUILD != "true" ]; then
+  echo "Removing folder ./pkg/test-pkg"
+  rm -rf ./pkg/test-pkg
+fi
+
+yarn create @rancher/pkg test-pkg -t -i
 cp ${SHELL_DIR}/list/catalog.cattle.io.clusterrepo.vue ./pkg/test-pkg/list
 FORCE_COLOR=true yarn build-pkg test-pkg | cat
-rm -rf ./pkg/test-pkg
+if [ $TEST_PERSIST_BUILD != "true" ]; then
+  echo "Removing folder ./pkg/test-pkg"
+  rm -rf ./pkg/test-pkg
+fi
+
+# function to clone repos and install dependencies (including the newly published shell version)
+function clone_repo_test_extension_build() {
+  REPO_NAME=$1
+  PKG_NAME=$2
+
+  echo -e "\nSetting up $REPO_NAME repository locally\n"
+
+  # set registry to default (to install all of the other dependencies)
+  yarn config set registry ${DEFAULT_YARN_REGISTRY}
+
+  if [ $TEST_PERSIST_BUILD != "true" ]; then
+    echo "Removing folder ${BASE_DIR}/$REPO_NAME"
+    rm -rf ${BASE_DIR}/$REPO_NAME
+  fi
+
+  # cloning repo
+  git clone https://github.com/rancher/$REPO_NAME.git
+  pushd ${BASE_DIR}/$REPO_NAME
+
+  echo -e "\nInstalling dependencies for $REPO_NAME\n"
+  yarn install
+
+  # set registry to local verdaccio (to install new shell)
+  yarn config set registry ${VERDACCIO_YARN_REGISTRY}
+
+  # update package.json to use a specific version of shell
+  sed -i.bak -e "s/\"\@rancher\/shell\": \"[0-9]*.[0-9]*.[0-9]*\",/\"\@rancher\/shell\": \"${SHELL_VERSION}\",/g" package.json
+  rm package.json.bak
+
+  # we need to remove yarn.lock, otherwise it would install a version that we don't want
+  rm yarn.lock
+
+  echo -e "\nInstalling newly built shell version\n"
+
+  # installing new version of shell
+  yarn add @rancher/shell@${SHELL_VERSION}
+
+  # test build-pkg
+  FORCE_COLOR=true yarn build-pkg $PKG_NAME | cat
+
+  # # kubewarden has some unit tests and they should be quick to run... Let's check them as well
+  # if [ "${REPO_NAME}" == "kubewarden-ui" ]; then
+  #   yarn test:ci
+  # fi
+
+  # return back to the base path
+  popd
+
+  # delete folder
+  if [ $TEST_PERSIST_BUILD != "true" ]; then
+    echo "Removing folder ${BASE_DIR}/$REPO_NAME"
+    rm -rf ${BASE_DIR}/$REPO_NAME
+  fi
+  yarn config set registry ${DEFAULT_YARN_REGISTRY}
+}
+
+# Here we just add the extension that we want to include as a check (all our official extensions should be included here)
+# Don't forget to add the unit tests exception to clone_repo_test_extension_build function if a new extension has those
+clone_repo_test_extension_build "kubewarden-ui" "kubewarden"
+clone_repo_test_extension_build "elemental-ui" "elemental"
 
 echo "All done"