BenoitFreslon · May 31, 2020 · Jun 10, 2020 · Jun 10, 2020 · Jun 13, 2020 · Jun 13, 2020
diff --git a/.env b/.env
@@ -0,0 +1,5 @@
+# ---------------------
+# dotenv: Environment variables
+# to be used inside of npm scripts
+# ---------------------
+REPOSITORY_ROOT=$PWD
diff --git a/.github/scripts/functions.sh b/.github/scripts/functions.sh
@@ -0,0 +1,351 @@
+#!/bin/bash
+# @file functions
+# @brief CI and local package release "automation" functions.
+
+#
+# @description Parse and return a version value from a "package.json" file
+#
+# @see [shdoc](https://github.com/reconquest/shdoc)
+# @example
+#   packageVersion "<PATH>/package.json"
+packageVersion() {
+    local package_json_file=$1
+    local version=""
+    while read a b ; do 
+        [ "$a" = '"version":' ] && { b="${b%\"*}" ; version="${b#\"}" ; break ; }
+    done < $package_json_file
+    echo $version
+}
+
+# 
+# @description $PKG_ROOT environment variable check. Should be a string
+#              with a root path of the package
+#
+# @see $PKG_ROOT
+checkPkgRoot() {
+    if [ -z "$PKG_ROOT" ]
+    then
+        PKG_ROOT=$1
+        if [ -z "$PKG_ROOT" ]
+        then
+            PKG_ROOT="."
+        fi
+    fi
+}
+
+# 
+# @description Replace .env (default) file content with $PKG_ROOT variable value
+#
+# @see $PKG_ROOT
+fixEnvFile() {
+    # $PKG_ROOT environment variable check
+    checkPkgRoot $1
+
+    # Fix env (default) file with correct value 
+    # for environment variables
+    if [ -f "$PKG_ROOT/.env" ]
+    then
+        echo "[FIX .ENV] Replaced $(cat "$PKG_ROOT/.env") to => REPOSITORY_ROOT=."
+        echo "REPOSITORY_ROOT=." > "$PKG_ROOT/.env"
+    fi
+}
+
+# @description Add github actions state and output variables to be handled on .yml workflow files
+#
+# @see $GITHUB_OUTPUT
+# @see [Deprecating save-state and set-output commands](https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands)
+# @see [Github Actions: Output parameter](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter)
+githubActionsOutputs() {
+    # PS: CURRENT_TAG and COMMIT_MESSAGE are handled here as "global/environment" variables
+    CURRENT_TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
+    COMMIT_MESSAGE=$(git log -1 --pretty=%B)
+
+    echo "[GITHUB VARIABLES] Commit => $COMMIT_MESSAGE"
+
+    # Use the format {name}={value} instead of ::set-output
+    echo "TAG=$CURRENT_TAG" >> $GITHUB_OUTPUT
+    echo "COMMIT_MESSAGE=$COMMIT_MESSAGE" >> $GITHUB_OUTPUT
+}
+
+# @description Copy all content of the package folder to the ROOT dir
+#
+# @see [shdoc](https://github.com/reconquest/shdoc)
+# @example
+#   # From the root folder, with "Packages/<PACKAGE_NAME>"
+#   copyPackagesContent
+#   # result: Copy "Packages/<PACKAGE_NAME>/*.*" to ROOT/
+copyPackagesContent() {
+    shopt -s extglob dotglob
+
+    cp -rvf "Packages/$PKG_NAME/." "$PKG_ROOT/"
+    rm -rf ./Packages
+}
+
+# TODO: Move this common function to another script file in order to reuse (e.g .github/scripts/common.sh)
+#
+# @description Rename invalid package directories to be "untracked" by game engine, adding a "~" suffix
+#              (e.g "Samples" => "Samples~", "Documentation" => "Documentation~")
+#
+# @see $PKG_ROOT
+# @see [shdoc](https://github.com/reconquest/shdoc)
+renameInvalidDirs() {
+    # $PKG_ROOT environment variable check
+    checkPkgRoot $1
+
+    if [ $PKG_ROOT = "./" ]
+    then
+        echo "[RENAME DIRECTORIES] [Error] The \$PKG_ROOT => '$PKG_ROOT' should be just '.' for current directory."
+        return 1
+    fi
+
+    echo "[RENAME DIRECTORIES] Package Root: $PKG_ROOT/"
+
+    chmod -R 777 "$PKG_ROOT/"
+
+    # Rename UPM special directories with suffix "~"
+    if [ -d "$PKG_ROOT/Samples" ]
+    then
+        # PS: Replaced "mv" to "copy" + "remove" of Samples~ dir, because sometimes
+        #     shows the error Permission Denied. Specially if Samples
+        #     have several sub-directories
+        if [ ! -d "$PKG_ROOT/Samples~" ]
+        then 
+            mkdir -p "$PKG_ROOT/Samples~"
+        fi
+
+        cp -Rf "$PKG_ROOT/Samples/." "$PKG_ROOT/Samples~/"
+
+        rm -rf "$PKG_ROOT/Samples"
+        rm -f "$PKG_ROOT/Samples.meta"
+
+        echo "[RENAMED] Samples => $PKG_ROOT/Samples~"
+    fi
+    if [ -d "$PKG_ROOT/Documentation" ] && [ ! -d "$PKG_ROOT/Documentation~" ]
+    then
+        mv "$PKG_ROOT/Documentation" "$PKG_ROOT/Documentation~"
+        rm -f "$PKG_ROOT/Documentation.meta"
+
+        echo "[RENAMED] Documentation => $PKG_ROOT/Documentation~"
+    fi
+}
+
+# 
+# @description Commit with a new version of the package and push the $PKG_BRANCH 
+#              new orphan branch (usually "upm" branch)
+#
+# @see $PKG_BRANCH
+# @see renameInvalidDirs()
+# @see fixEnvFile()
+commitAndPush() {
+    # Incrementing LAST_RELEASE_TAG+1.
+    # Keep here just to store the history, and if need this to the future/others repositories
+    #
+    # PS: Keep in mind that not always you would like to increment the git tag version (e.g rewriting with force an existent git tag)
+    # [[ "$LAST_RELEASE_TAG" =~ (.*[^0-9])([0-9]+)$ ]] && LAST_RELEASE_TAG="${BASH_REMATCH[1]}$((${BASH_REMATCH[2]} + 1))";
+
+    local release_version=$(packageVersion "./package.json")
+
+    echo "[COMMIT AND PUSH] New version: $release_version"
+
+    renameInvalidDirs
+
+    git config --global user.name 'github-bot'
+    git config --global user.email 'github-bot@users.noreply.github.com'
+    git add .
+    git commit --allow-empty -am "$COMMIT_MESSAGE"
+
+    echo $release_version > VERSION.md~
+
+    # .env (default) file path fix
+    fixEnvFile
+
+    git add VERSION.md~
+    git commit -am "fix: Samples => Samples~ and commit a new version: $release_version"
+    git push -f -u origin "$PKG_BRANCH"
+}
+
+# TODO: Move this function to another script file (e.g .github/scripts/local.sh)
+# 
+# @description Copy a list of files and dirs from the ROOT to the package folder
+#
+# @arg $1 string A path configured as "$repository_root" local variable to be used as an origin
+#                path to copy content into package dir
+# @arg $2 string A path configured as "$PKG_ROOT" environment variable to be used as 
+#                root path of the package
+#
+# @see $PKG_ROOT
+# @see [Exit the Bash Script if a Certain Condition Occurs](https://itslinuxfoss.com/exit-bash-script-if-certain-condition-occurs)
+# @see [How to Check if a File or Directory Exists in Bash](https://linuxize.com/post/bash-check-if-file-exists)
+copyFilesForPublish() {
+    local repository_root=$1
+
+    # $PKG_ROOT environment variable check
+    checkPkgRoot $2
+    local pkg_root_full_path=$(realpath $PKG_ROOT)
+
+    if [ -z "$repository_root" ]
+    then
+        echo "[COPY FILES] The parameter \$1 => \$repository_root is required: '$repository_root'"
+        return 1
+    else
+        if [[ "$repository_root" =~ \.$ ]]
+        then
+            repository_root="$repository_root/"
+        fi
+    fi
+
+    if [[ $repository_root == $pkg_root_full_path ]]
+    then
+        echo "[COPY FILES] Cannot copy a directory FROM: \$repository_root => '$repository_root' to \$PKG_ROOT => '$pkg_root_full_path', into itself"
+        return 1
+    fi
+
+    chmod -R 777 "$PKG_ROOT/"
+
+    echo "[COPY FILES] From \$repository_root: '$(realpath $repository_root)', to => \$PKG_ROOT: '$pkg_root_full_path'"
+
+    local files_copy=(README.md README.md.meta LICENSE LICENSE.meta Images Images.meta)
+    for file_name in "${files_copy[@]}"
+    do
+        if [[ -f "$repository_root/$file_name" && ! -f "$PKG_ROOT/$file_name" ]] || [[ -d "$repository_root/$file_name" && ! -d "$PKG_ROOT/$file_name" ]]
+        then
+            cp -rf "$repository_root/$file_name" "$PKG_ROOT/$file_name"
+            echo "[COPY FILES] Copied: $PKG_ROOT/$file_name"
+        fi
+    done
+}
+
+# TODO: [Feature] Use this function to loop over all packages and do all operations (copy files, rename and publish)
+# @see checkPkgRoot
+# @see [How do you store a list of directories into an array in Bash?](https://stackoverflow.com/a/4495304)
+fetchPackages() {
+    local packages_root=$1
+    checkPkgRoot
+
+    # PS: "<PATH>/*/" is a glob that list only directories
+    if [ -z $packages_root ]
+    then
+        packages_root=(
+            $PKG_ROOT/Packages/*/
+        )
+    elif [ -d $packages_root ]
+    then
+        packages_root=(
+            $packages_root/*/
+        )
+    fi
+
+    for package_path in "${packages_root[@]}" 
+    do
+        echo "[FETCH PACKAGES] Package: '$package_path'"
+    done
+}
+
+# TODO: Move this function to another script file (e.g .github/scripts/local.sh)
+# TODO: Move common functions dependencies to another script file in order to reuse (e.g .github/scripts/common.sh)
+# 
+# @description Automate all actions required before PUBLISH a package in a remote registry
+#
+# @arg $1 string A path configured as "$repository_root" local variable to be used as an origin
+#                path to copy content into package dir
+# @arg $2 string A path configured as "$PKG_ROOT" environment variable to be used as 
+#                root path of the package
+#
+# @arg $3 string A flag configured as "$PUBLISH_FORCE" environment variable to force 
+#                publish from "./" root path (usually when publishing packages from a local repo)
+#
+# @see $PKG_ROOT
+# @see $PUBLISH_FORCE
+# @see renameInvalidDirs($PKG_ROOT)
+# @see copyFilesForPublish($1)
+# @see [Using Boolean Variables in Shell Scripts](https://tecadmin.net/boolean-variable-in-shell-script)
+localBeforePublish() {
+    local repository_root=$1
+    local publish_forced='false'
+
+    # Check if publish "force" is true
+    if [ -z "$PUBLISH_FORCE" ]
+    then
+        PUBLISH_FORCE=$3
+        if [ -z "$PUBLISH_FORCE" ]
+        then
+            PUBLISH_FORCE=0
+        fi
+    fi
+
+    if [ $PUBLISH_FORCE -eq 1 ]
+    then
+        publish_forced='true'
+    fi
+
+    if [ -d $repository_root ] && [[ $repository_root != "./" && $repository_root != "." || $PUBLISH_FORCE -eq 1 ]]
+    then
+
+        echo "[PUBLISH: BEFORE/PRE] Forced => '$publish_forced'"
+
+        # $PKG_ROOT environment variable check
+        checkPkgRoot $2
+
+        renameInvalidDirs $PKG_ROOT
+        copyFilesForPublish $repository_root
+    else
+        echo "[PUBLISH: BEFORE/PRE] [Skip] Bypass package preparation because \$1 : \$repository_root => '$repository_root' is invalid"
+    fi
+}
+
+# TODO: Move this function to another script file (e.g .github/scripts/local.sh)
+# 
+# @description PUBLISH a package in a remote registry. Usually used inside of a npm script
+#
+# @arg $1 string Overrides the $PKG_ROOT environment variable with a path to a package
+#
+# @see $PKG_ROOT
+localPublish() {
+    # $PKG_ROOT environment variable check
+    checkPkgRoot $1
+
+    cd $PKG_ROOT
+
+    # Install dev dependencies if weren't installed yet
+    if [ ! -d "./node_modules" ]
+    then
+        npm i    
+    fi
+    npm run package:prepare && npm publish
+}
+
+run() {
+    if [ $1 == "push" ]
+    then
+        commitAndPush
+    elif [ $1 == "movePackagesFolder" ]
+    then
+        copyPackagesContent
+    elif [ $1 == "githubActionsVariables" ]
+    then
+        githubActionsOutputs
+    elif [ $1 == "fetchPackages" ]
+    then
+        fetchPackages $2
+    elif [ $1 == "copyFilesForPublish" ]
+    then
+        copyFilesForPublish $2 $3
+    elif [ $1 == "fixEnvFile" ]
+    then
+        fixEnvFile $2
+    elif [ $1 == "renameInvalidDirs" ]
+    then
+        renameInvalidDirs $2
+    elif [ $1 == "localBeforePublish" ]
+    then
+        localBeforePublish $2
+    elif [ $1 == "localPublish" ]
+    then
+        localPublish $2
+    else
+        echo "[ERROR] INVALID SCRIPT OPERATION"
+        exit 1
+    fi
+}
+
+run $1 $2 $3