@mservices-tech/scripts 3.2.2

package/bump_version/bump_version.sh

@@ -0,0 +1,93 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+function usage() {
+  cat << END
+Usage:
+  ./bump_version.sh [--help] [--prerelease] [--package-json-transform=transform_string] [--include-dependency-changes] [--dry-run]
+Where:
+  help                    - show usage information and exit
+  package-json-transform  - optional string with jq transforms that will be applied
+                            to package.json *before* upgrading version
+  prerelease             - create a release candidate for the package
+  include-dependency-changes - include dependency changes in changelog (default: off)
+  dry-run                 - run standard-version in dry run mode
+Description:
+  Bumps semantic version of the package using
+  standard-version (https://www.npmjs.com/package/standard-version)
+
+  Note:
+    * assumes standard-version is installed
+      in the package that uses bump_version script
+    * it does note generate changelog
+    * you can override/adjust standard-version .versionrs.js configuration file
+      options via command-line parameters
+      (see: https://github.com/conventional-changelog/standard-version?tab=readme-ov-file#configuration)
+END
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  local dry_run_arg=()
+  if [ ${PROCESS_ARGUMENTS['--dry-run']} ]; then
+    dry_run_arg+=("--dry-run")
+  fi
+
+  if [ ${PROCESS_ARGUMENTS['--package-json-transform']} ]; then
+    jq --raw-output "${PROCESS_ARGUMENTS['--package-json-transform']}" package.json > package.json.tmp \
+      && mv package.json.tmp package.json
+  fi
+
+  local -r current_script_directory="$(dirname "${BASH_SOURCE[0]}")"
+  cp "$current_script_directory"/.versionrc.js .
+
+  # Set environment variable for changelog enrichment if flag is set
+  if [ ${PROCESS_ARGUMENTS['--include-dependency-changes']} ]; then
+    export TRACK_DEPENDENCIES=true
+    # Ensure the enrichment script is executable
+    chmod +x "$current_script_directory/../enrich_changelog_with_dependency_changes/enrich_changelog_with_dependency_changes.sh"
+  fi
+
+  local -r package_name="$(basename "$(pwd)")"
+  local -r package_tag_prefix="$package_name-"
+  # {{currentTag}} comes from standard-version
+  # Example release commit format:
+  # chore: Release eslint-config version 1.2.4
+  local -r release_commit_message="chore($package_name): Release $package_name version {{currentTag}}"
+
+  if [ ${PROCESS_ARGUMENTS['--prerelease']} ]; then
+    # Sanitize branch name to be semver compliant
+    local -r current_branch_name=$(git rev-parse --abbrev-ref HEAD | sed -E -e 's/[^a-zA-Z0-9]+/-/g' -e 's/^-//' -e 's/-$//' -e 's/\./-/g')
+    ./node_modules/.bin/standard-version \
+      "${dry_run_arg[@]}" \
+      --releaseCommitMessageFormat="$release_commit_message" \
+      --tag-prefix="$package_tag_prefix" \
+      --skip.changelog \
+      --prerelease "$current_branch_name-rc"
+  else
+    release_tags_for_package=$(git tag | grep "$package_tag_prefix""[[:digit:]]")
+
+    if [[ -z $release_tags_for_package ]]; then
+      # No tags found for the package → do the first release
+      printf "Doing first release of the package\n"
+      ./node_modules/.bin/standard-version \
+        "${dry_run_arg[@]}" \
+        --first-release \
+        --releaseCommitMessageFormat="$release_commit_message" \
+        --tag-prefix="$package_tag_prefix"
+    else
+      ./node_modules/.bin/standard-version \
+        "${dry_run_arg[@]}" \
+        --releaseCommitMessageFormat="$release_commit_message" \
+        --tag-prefix="$package_tag_prefix"
+    fi
+  fi
+}
+
+main "$@"

package/clean/clean.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+
+source "$(dirname "$0")/../utils.sh" || exit 1
+
+function usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--remove-env] [--dry-run] [--help]
+Where:
+  help       - whether to print usage information and exit
+  remove-env - also remove '.env' files (caution!)
+  dry-run    - show what would be removed without actually deleting
+Description:
+  Removes all untracked files from the repository, with an
+  exception of '.env' files, which may contain crucial tokens.
+  In order to remove '.env' files too, use an appropriate
+  argument switch.
+END
+}
+
+function conditional_remove() {
+  local file="$1"
+  local dry_run="$2"
+
+  logger_info "Removing $file"
+  [ ! $dry_run ] && rm -r "$file"
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  local dry_run=${PROCESS_ARGUMENTS['--dry-run']}
+  local files=$(git clean -Xd --dry-run | sed "s/Would\ remove\ //")
+
+  if [ $dry_run ]; then
+    logger_info "DRY RUN MODE - No files will be deleted"
+  fi
+
+  for file in ${files[@]}; do
+    if [ -z ${file%.env*} ]; then
+      # This is a .env file - only remove if --remove-env flag is set
+      if [ ${PROCESS_ARGUMENTS['--remove-env']} ]; then
+        conditional_remove "$file" "$dry_run"
+      else
+        logger_info "Skipping $file (use --remove-env to remove)"
+      fi
+    elif [[ "$file" != "node_modules"* ]]; then
+      conditional_remove "$file" "$dry_run"
+    fi
+  done
+
+  if [ $dry_run ]; then
+    logger_info "DRY RUN COMPLETE - No files were deleted"
+  fi
+}
+
+main "$@"

package/copy_package_build_to_project/copy_package_build_to_project.sh

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+
+source "$(dirname "$0")/../utils.sh" || exit 1
+
+function usage() {
+  cat << END
+Usage:
+  ./copy_to_project.sh [--help] <--node-module-path> <--project-path>
+Where:
+  help                    - show usage information and exit
+  node-module-path      - relative path of the folder in node_modeles where built project is located
+                          eg. @mservicestech/utils or @mbank-design/design-system
+  project-path            - path of project package to which the build should be copied
+Description:
+  Copies the built project to the node_modules of project specified
+  in --project-path, to the folder specified by --node-module-path
+
+  Note:
+    * assumes the project to copy is already built
+END
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ "${PROCESS_ARGUMENTS['--help']}" ]; then
+    usage
+    exit 0
+  fi
+
+  if ! [ "${PROCESS_ARGUMENTS['--node-module-path']}" ]; then
+    printf "No path in node_modules where files should be copied provided. Run with '--help' for more information.\n"
+    exit 0
+  fi
+
+  if ! [ "${PROCESS_ARGUMENTS['--project-path']}" ]; then
+    printf "No project path was provided. Pass relative path to target package in --project-path argument. Run with '--help' for more information.\n"
+    exit 0
+  fi
+
+  rm -rf "${PROCESS_ARGUMENTS['--project-path']}"/node_modules/"${PROCESS_ARGUMENTS['--node-module-path']}"
+  mkdir -p "${PROCESS_ARGUMENTS['--project-path']}"/node_modules/"${PROCESS_ARGUMENTS['--node-module-path']}"
+  cp -rp build/* "${PROCESS_ARGUMENTS['--project-path']}"/node_modules/"${PROCESS_ARGUMENTS['--node-module-path']}"
+  echo "Sucessfully copied build to: ${PROCESS_ARGUMENTS['--project-path']}"/node_modules/"${PROCESS_ARGUMENTS['--node-module-path']}"
+
+}
+main "$@"

package/delete_and_fetch_git_tags/delete_and_fetch_git_tags.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+function usage() {
+  cat << END
+Usage:
+  ./delete_and_fetch_git_tags.sh [--help]
+Where:
+  help - print usage information and exit
+Description:
+  Deletes and fetches all git tags. Run to make sure all local tags match remote
+  tags and because our release system depends on tags.
+
+  Note: this is needed for standard-version (release tool) to work correctly
+  and is a workaround for https://github.com/actions/checkout/issues/290
+
+  Without this script, tags would not be properly added to the release after.
+
+  It should be run *before* standard-version.
+END
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  git tag --list | xargs git tag --delete
+  git fetch --all --tags
+}
+
+main "$@"

package/docker/docker.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+source "$(dirname $0)/docker_utils.sh" || exit 1
+
+usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help] <--action> [--build-directory] [--port-map] [--arguments]
+Where:
+  help            - print usage information and exit
+  action          - an action to perform, one of 'build', 'push' or 'run'
+  build-directory - the build directory from which to operate, default 'build'
+  port-map        - a port mapping for the 'run' action, e.g "8080:80"
+  arguments       - quoted list of arguments to pass into Docker runtime
+  organization    - a GitHub organization name for tag fetching
+Description:
+  Performs a specified action with a docker image. Build, run or
+  push the image to the remote repository.
+END
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+
+  if ! [ ${PROCESS_ARGUMENTS['--action']} ]; then
+    printf "No action provided. Run with '--help' for more information.\n"
+    exit 1
+  fi
+  if ! [ ${PROCESS_ARGUMENTS['--organization']} ]; then
+    printf "No organization provided. Run with '--help' for more information.\n"
+    exit 1
+  fi
+
+  local tag_names
+  tag_names=$(get_container_image_names "${PROCESS_ARGUMENTS['--organization']}")
+
+  if [ -z "$tag_names" ]; then
+    printf "No tag names found. Exiting.\n"
+    exit 1
+  fi
+
+  case ${PROCESS_ARGUMENTS['--action']} in
+    "build")
+      docker_build \
+        --tag-names="$tag_names" \
+        --build-directory="${PROCESS_ARGUMENTS['--build-directory']:-"build"}" \
+        --arguments="${PROCESS_ARGUMENTS['--arguments']}"
+      ;;
+    "push")
+      docker_push \
+        --tag-names="$tag_names" \
+        --arguments="${PROCESS_ARGUMENTS['--arguments']}"
+      ;;
+    "run")
+      docker_run_latest \
+        --tag-names="$tag_names" \
+        --port-mapping="${PROCESS_ARGUMENTS['--port-map']:-"8080:80"}" \
+        --arguments="${PROCESS_ARGUMENTS['--arguments']}"
+      ;;
+  esac
+}
+
+main "$@"

package/docker/docker_utils.sh

@@ -0,0 +1,143 @@
+#!/usr/bin/env bash
+source "$(dirname $0)/../utils.sh" || exit 1
+
+# description:
+#   creates a list of container image names based on the current project name and version
+# usage:
+#   get_container_image_names organization_name
+# returns:
+#   a list of container image names separated by spaces
+function get_container_image_names() {
+  organization_name="$1"
+
+  # Project name from package.json, without namespace prefix
+  # (e.g. @organization/project-name --> project-name)
+  project_name=$(grep name package.json \
+    | head -1 \
+    | awk --field-separator=: '{ print $2 }' \
+    | awk --field-separator=/ '{ print $2 }' \
+    | sed 's/[", ]//g')
+
+  # Package version from package.json
+  package_version=$(grep version package.json \
+    | head -1 \
+    | awk --field-separator=: '{ print $2 }' \
+    | sed 's/[", ]//g')
+
+  container_tags=$(printf "ghcr.io/%s/%s:%s ghcr.io/%s/%s:latest" \
+    "$organization_name" "$project_name" "$package_version" \
+    "$organization_name" "$project_name")
+
+  echo "$container_tags"
+}
+
+# description:
+#   Pushes container images to the container registry
+#   Note: it assumes that the user is already logged in into the container registry
+# usage:
+#   docker_push --tag-names="<tag name 1> <tag name 2> ..."
+# where:
+#   tag names - a list of container image names separated by spaces
+# requirements:
+#   GITHUB_USER environment variable must be set
+#   NPM_TOKEN environment variable must be set
+# returns:
+#   0 if successful
+#   1 if unsuccessful
+function docker_push() {
+  if [ -z "$GITHUB_USER" ]; then printf "You need to define GITHUB_USER variable\n" && return 1; fi
+  if [ -z "$NPM_TOKEN" ]; then printf "You need to define NPM_TOKEN variable\n" && return 1; fi
+
+  parse_arguments "$@"
+
+  local tag_names="${PROCESS_ARGUMENTS['--tag-names']}"
+  printf "Pushing container with tags:\n%s\n" "$(echo "$tag_names" | sed 's/ /\n/g')"
+
+  docker_command_return_code=-1
+  for tag in $tag_names; do
+    if [[ "$tag" =~ ^ghcr.io.* ]] || [[ "$tag" =~ ^eu.gcr.io.* ]]; then
+      echo "Pushing $tag"
+      docker push "$tag"
+      docker_command_return_code=$?
+    fi
+    if [ $docker_command_return_code -ne 0 ]; then
+      break
+    fi
+  done
+  exit $docker_command_return_code
+}
+
+# description:
+#   builds a container image
+# usage:
+#   docker_build --tag-names="<tag name 1> <tag name 2> ..." --build-directory="<build directory name>"
+# where:
+#   tag names - a list of container image names separated by spaces
+#   build directory name - a name of the directory where the build is located
+# requirements:
+#   build directory must exist
+# returns:
+#   0 if successful
+#   1 if unsuccessful
+function docker_build() {
+
+  parse_arguments "$@"
+
+  local tag_names="${PROCESS_ARGUMENTS['--tag-names']}"
+  local build_directory_name="${PROCESS_ARGUMENTS['--build-directory']}"
+  local arguments="${PROCESS_ARGUMENTS['--arguments']}"
+
+  printf "Building container with tags: %s\n" "$(echo "$tag_names" | sed 's/ /\n/g')"
+
+  if [ ! -d "$build_directory_name" ]; then
+    printf "Directory 'build' does not exist. You have to build the application before building the Docker image\n"
+    exit 1
+  fi
+
+  docker_command_return_code=-1
+  for tag in $tag_names; do
+    if [[ "$tag" =~ ^ghcr.io.* ]] || [[ "$tag" =~ ^eu.gcr.io.* ]]; then
+      docker build --tag "$tag" --file Dockerfile "$arguments"
+      docker_command_return_code=$?
+    fi
+    if [ $docker_command_return_code -ne 0 ]; then
+      break
+    fi
+  done
+  exit $docker_command_return_code
+}
+
+# description:
+#   runs a container image with the latest tag
+# usage:
+#   docker_run_latest --tag-names="<tag name 1> <tag name 2> ..." --port-mapping="<port mapping>" --environment-variables-file="<environment variables file>"
+# where:
+#   tag names - a list of container image names separated by spaces
+#   port mapping - a port mapping in the format <host port>:<container port>
+#   environment variables file - a path to a file with environment variables
+# returns:
+#   0 if successful
+#   1 if unsuccessful
+function docker_run_latest() {
+
+  parse_arguments "$@"
+
+  local port_mapping="${PROCESS_ARGUMENTS['--port-mapping']}"
+  local environment_variables_file="${PROCESS_ARGUMENTS['--environment-variables-file']}"
+  local tag_names="${PROCESS_ARGUMENTS['--tag-names']}"
+  local environment_variables_file_flag=""
+
+  if [ ! -z "$environment_variables_file" ]; then
+    environment_variables_file_flag="--env-file $environment_variables_file"
+  fi
+
+  for tag in $tag_names; do
+    if [[ "$tag" =~ ^ghcr.io.* ]] && [[ "$tag" =~ :latest$ ]]; then
+      printf "Running container with tags: %s\n" "$(echo "$tag_names" | sed 's/ /\n/g')"
+      docker run --tty --init --interactive \
+        --publish "$port_mapping" \
+        "$environment_variables_file_flag" "$arguments" "$tag"
+      break
+    fi
+  done
+}

package/download_design_system_package/download_design_system_package.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+source "$(dirname $0)/../utils.sh" || exit 1
+
+usage() {
+  cat << END
+Usage:
+  ${BASH_SOURCE[0]} [--help] <--version=<version>>
+Where:
+  help    - print usage information and exit
+  scope   - design system package scope
+  version - design-system version (e.g. 26.1.0)
+Description:
+  Downloads design-system package in 'tgz' format to current location.
+END
+}
+
+function main() {
+  parse_arguments "$@"
+  if [ ${PROCESS_ARGUMENTS['--help']} ]; then
+    usage
+    exit 0
+  fi
+  if ! [ ${PROCESS_ARGUMENTS['--scope']} ]; then
+    printf "Package scope was not provided. Run with '--help' for more information."
+    exit 1
+  fi
+
+  echo "Getting link..."
+  link=$(npm view @${PROCESS_ARGUMENTS['--scope']}/design-system@"${PROCESS_ARGUMENTS['--version']}" dist.tarball)
+  echo "Downloading the package..."
+  curl \
+    --location \
+    --header "Authorization: Bearer $NPM_TOKEN" \
+    -X GET "$link" \
+    --output design-system-"${PROCESS_ARGUMENTS['--version']}".tgz
+
+  echo "Saved in $(pwd) as design-system-${PROCESS_ARGUMENTS['--version']}.tgz"
+}
+
+main "$@"