@aurodesignsystem/auro-library 2.3.2 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Semantic Release Automated Changelog
 
+# [2.4.0](https://github.com/AlaskaAirlines/auro-library/compare/v2.3.2...v2.4.0) (2024-01-26)
+
+
+### Features
+
+* add shell scripts ([caccc2a](https://github.com/AlaskaAirlines/auro-library/commit/caccc2a62855337727c4a805d2cc9e3879c42e18))
+
 ## [2.3.2](https://github.com/AlaskaAirlines/auro-library/compare/v2.3.1...v2.3.2) (2024-01-25)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurodesignsystem/auro-library",
-  "version": "2.3.2",
+  "version": "2.4.0",
   "description": "This repository holds shared scripts, utilities, and workflows utilized across repositories along the Auro Design System.",
   "repository": {
     "type": "git",

package/shellScripts/README.md

@@ -0,0 +1,58 @@
+# Automated shell scripts
+
+In this repo is a single shell script that contains functions designed to do automated tasks locally, prepare those updates and push them to their individual remote repos.
+
+### Install shell script
+
+This shell script, and others, can be installed anywhere in your local environment. If you chose, installing the npm in a global space is acceptable as well.
+
+To access the script(s) from your command line, it is required to source the file when a new shell is opened.
+
+With BASH, it is common to add a `source` command in the `~./bash_profile` config file. In the following code example the `automation.sh` shell script was placed into the `~/.bash_resources` directory.
+
+```shell
+source ~/.bash_resources/automation.sh
+```
+
+### What's in the script?
+
+`gitVersion`
+
+This is a simple function that when within a repo's directory, from the CLI you can run `gitVersion` and it will print out the version number from the repo's package.json file.
+
+This is handy for things like having an alias to a repo's directory. For example, you could have an alias for the `auro-menu` component that takes you to the repo's directory and prints out the package version.
+
+```shell
+alias menu="cd ~/src/auro/menu && gitVersion"
+```
+
+`updateRepos`
+
+This function takes an array of all the repo directories in your local setup that you want to loop through, determine what the HEAD branch is, check it out and perform a `git pull`.
+
+With this one command you can ensure that all your local repos have the latest versions from the remote.
+
+`addToRepo`
+
+This function is like a sandwich. There is the first part that ensures that the repo is up to date. Much like the `updateRepos` function, and then it ends with a commit and a push.
+
+In the middle is the part where custom actions can be written that allow for simple repetitive updates to be scripted.
+
+Need to add a new file to all the repos?
+
+```shell
+command cp ../WC-Generator/.github/workflows/addToProject.yml .github/workflows/addToProject.yml
+```
+
+Need to do a search and replace of content in a specific file and delete the temp resource created?
+
+```shell
+command sed -i -e 's/@v3/@v4/g' .github/workflows/testPublish.yml
+command rm .github/workflows/testPublish.yml-e
+```
+
+`openActions`
+
+This really simple function takes an array and constructs a URL on the fly to be opened by your default browser.
+
+This function specifically opens all the Auro element actions page. This is a great way to do a quick scan of all the repos to ensure that actions are working as expected and there are no unknown blocked releases because you missed a notification from Github.

package/shellScripts/automation.sh

@@ -0,0 +1,104 @@
+#!/bin/bash
+
+# Simple function that looks into a repo's package.json and print out
+# the current verison released.
+function gitVersion {
+  # Version key/value should be on his own line
+  PACKAGE_VERSION=$(cat package.json \
+    | grep version \
+    | head -1 \
+    | awk -F: '{ print $2 }' \
+    | sed 's/[",^|]//g')
+
+  echo -e "Package version -$PACKAGE_VERSION"
+}
+
+# This function will loop through all the repos listed
+# and do a `git pull` for each repo before moving on.
+function updateRepos {
+  ## declare an array variable
+  declare -a arr=("alert" "WC-Generator/" "drawer/" "wcss/" "hyperlink/" "auro-lockup/" "icons/" "flight/" "dialog/" "banner/" "card/" "nav/" "datepicker/" "popover/" "dropdown/" "radio/" "checkbox/" "button/" "loader/" "flightline/" "b2top/" "combobox/" "carousel/" "table/" "toast/" "icon/" "select/" "sidenav/" "pane/" "header/" "datetime/" "input/" "avatar/" "badge/" "background/" "interruption/" "skeleton/" "menu/" "eslint-config/" "tokens/"
+ )
+
+  ## now loop through the above array
+  for i in "${arr[@]}"
+  do
+    echo -e "\n$i\n"
+    command cd ~/src/auro/"$i"
+    echo "look at me in '$i'"
+    gitVersion
+    branch=$(git symbolic-ref --short HEAD)
+    echo -e "making sure on $branch branch"
+    command git checkout $branch
+    echo -e "updating repo from remote"
+    command git pull
+
+  done
+}
+
+
+function addToRepo {
+  ## declare an array variable
+  declare -a arr=("wcss/" "icons/" "banner/" "card/" "radio/" "checkbox/" "button/" "loader/" "flightline/" "b2top/" "combobox/" "carousel/" "table/" "toast/" "icon/" "select/" "sidenav/" "pane/" "header/" "datetime/" "input/" "avatar/" "badge/" "background/" "interruption/" "skeleton/" "menu/" "eslint-config/" "tokens/")
+
+  ## now loop through the above array
+  for i in "${arr[@]}"
+  do
+    # CD into dir and ensure that the repo is
+    # up to date with a `git pull`
+    # -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+    echo -e "\n$i\n"
+    command cd ~/src/auro/"$i"
+    echo "look at me in '$i'"
+    sleep 1
+    gitVersion
+    branch=$(git symbolic-ref --short HEAD) # determins if the head is `master` or `main`
+    echo -e "making sure on $branch branch" # uses variable
+    command git checkout $branch # uses variable
+    echo -e "updating repo from remote"
+    command git pull
+    sleep 1
+
+    # Customize the action to be performed
+    # -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+    # This action will copy a resource from one dir to another
+    # to update the repo
+    command cp ../WC-Generator/.github/workflows/addToProject.yml .github/workflows/addToProject.yml
+    echo -e "Copied file to '$i' repo.\n"
+
+    # This action will look for `@v3` and replace with @v4
+    # in .github/workflows/testPublish.yml, then delete the
+    # temporary file that was created.
+    command sed -i -e 's/@v3/@v4/g' .github/workflows/testPublish.yml
+    command rm .github/workflows/testPublish.yml-e
+    echo -e "Updated workflow script\n"
+
+    # Perform git functions to add, commit and push
+    # -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+    sleep 1
+    command git add --all
+    sleep 1
+    command git commit -m "build: add auto-assign to project script"
+    echo -e "Commit added to Git\n"
+    echo -e "Pushing to the remote\n"
+    sleep 2
+    command git push
+    echo -e "Update pushed to the remote\n"
+    sleep 2
+
+  done
+}
+
+# This function will loop through the array to construct a URL for each repo's
+# actions landing page. This is great for validating that actions have
+# run successfully.
+function openActions {
+  ## declare an array variable
+  declare -a arr=("auro-alert" "WC-Generator/" "auro-drawer/" "webcorestylesheets/" "auro-hyperlink/" "auro-lockup/" "icons/" "auro-flight/" "auro-dialog/" "auro-banner/" "auro-card/" "auro-nav/" "auro-datepicker/" "auro-popover/" "auro-dropdown/" "auro-radio/" "auro-checkbox/" "auro-button/" "auro-loader/" "auro-flightline/" "auro-backtotop/" "auro-combobox/" "auro-carousel/" "auro-table/" "auro-toast/" "auro-icon/" "auro-select/" "auro-sidenav/" "auro-pane/" "auro-header/" "auro-datetime/" "auro-input/" "auro-avatar/" "auro-badge/" "auro-background/" "auro-interruption/" "auro-skeleton/" "auro-menu/" "eslint-config-auro/" "aurodesigntokens/")
+
+  ## now loop through the above array
+  for i in "${arr[@]}"
+  do
+    command open https://github.com/AlaskaAirlines/"$i"actions
+  done
+}