v5.0.0
=====================================================================
Excited to bring V5 to life. This includes some BREAKING CHANGES to
several aspects of ZSH-type scwrypts. Please refer to the readme
for upgrade details (specifically docs/upgrade/v4-to-v5.md)
--- New Features -------------------------
- ZSH testing library with basic mock capabilities
- new scwrypts environment file format includes metadata and more
advanced features like optional parent env overrides, selection
inheritence, and improved structurual flexibility
- speedup cache for non-CI runs of ZSH-type scwrypts
- ${scwryptsmodule} syntax now allows a consistent unique-naming
scheme for functions in ZSH-type scwrypts while providing better
insight into origin of API calls in other modules
- reusable, case-statement-driven argument parsers in ZSH-type scwrypts
--- Changes ------------------------------
- several utility function renames in ZSH-type scwrypts to improve
consistency
- documentation comments included in ZSH libraries
- ZSH-type scwrypts now allow library modules to live alongside
executables
(zsh/lib still supported; autodetection determines default)
--- Bug Fixes ----------------------------
- hardened environment checking for REQUIRED_ENV variables; this removes
the ability to overwrite variables in local function contexts
This commit is contained in:
Wryn (yage) Wagner
89
.config/create-new-env
Executable file
89
.config/create-new-env
Executable file
@@ -0,0 +1,89 @@
|
||||
#!/bin/zsh
|
||||
#
|
||||
# a temporary template conversion utility for env.template (<=v4)
|
||||
# to env.yaml (>=v5)
|
||||
#
|
||||
eval $(scwrypts --config)
|
||||
use -c scwrypts/environment-files
|
||||
|
||||
ENVIRONMENT_ROOT="$1"
|
||||
[ "$ENVIRONMENT_ROOT" ] || ENVIRONMENT_ROOT="${0:a:h}"
|
||||
|
||||
OLDENV="$ENVIRONMENT_ROOT/env.template"
|
||||
NEWENV="$ENVIRONMENT_ROOT/env.yaml"
|
||||
ENVMAP="$ENVIRONMENT_ROOT/.map.txt"
|
||||
|
||||
GROUP="$2"
|
||||
[ $GROUP ] || GROUP=scwrypts
|
||||
GENERATE_TEMPLATE \
|
||||
| sed '1,4d; /^$/d' \
|
||||
| sed -z 's/# \([^\n]*\)\n\([^\n]*\)=/\2=\n\2=DESCRIPTION=\1/g' \
|
||||
| sed '
|
||||
s/^export //
|
||||
/./i---
|
||||
s/\s\+$//
|
||||
s/__/=/g
|
||||
s/^\(AWS\|REDIS\)_/\1=/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=$/\L\1:\n \2:\n \3:\n \4:\n \5:/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=$/\L\1:\n \2:\n \3:\n \4:/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=$/\L\1:\n \2:\n \3:/
|
||||
s/^\([^=]*\)=\([^=]*\)=$/\L\1:\n \2:/
|
||||
s/^\([^=]*\)=$/\L\1:/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]\+\)$/\L\1:\n \2:\n \3:\n \4:\n \5: \E\6/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]\+\)$/\L\1:\n \2:\n \3:\n \4: \E\5/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]*\)=\([^=]\+\)$/\L\1:\n \2:\n \3: \E\4/
|
||||
s/^\([^=]*\)=\([^=]*\)=\([^=]\+\)$/\L\1:\n \2: \E\3/
|
||||
s/^\([^=]*\)=\([^=]\+\)$/\L\1: \E\2/
|
||||
s/: (\(.*\))/: [\1]/
|
||||
/^/,/:/{s/_/-/g}
|
||||
' \
|
||||
| sed '
|
||||
s/^ \(description:.*\)/ \1/
|
||||
s/description:/.DESCRIPTION:/
|
||||
' \
|
||||
| sed -z 's/\n\(\s\+\).DESCRIPTION:\([^\n]\+\)/\n\1.DESCRIPTION: >-\n\1 \2/g' \
|
||||
| yq eval-all '. as $item ireduce ({}; . *+ $item)' \
|
||||
> "$NEWENV" \
|
||||
;
|
||||
|
||||
cat -- "$OLDENV" \
|
||||
| sed '
|
||||
s/#.*//
|
||||
/^$/d
|
||||
s/^export //
|
||||
s/\s\+$//
|
||||
s/^\([^=]*\)=.*/\1=\n \1/
|
||||
' \
|
||||
| sed '
|
||||
/^ /s/.*/\L&/
|
||||
/^ /s/__/./g
|
||||
/^ /s/_/-/g
|
||||
s/^ /./
|
||||
s/\(aws\|redis\)-/\1./
|
||||
' \
|
||||
| perl -pe 's/=\n/^/' \
|
||||
| column -ts '^' \
|
||||
> "$ENVMAP" \
|
||||
;
|
||||
|
||||
while read line
|
||||
do
|
||||
ENV_VAR=$(echo $line | awk '{print $1;}')
|
||||
LOOKUP=$(echo $line | awk '{print $2;}')
|
||||
|
||||
cp "$NEWENV" "$NEWENV.temp"
|
||||
cat "$NEWENV.temp" \
|
||||
| yq ". | $LOOKUP.[\".ENVIRONMENT\"] = \"$ENV_VAR\"" \
|
||||
| yq 'sort_keys(...)' \
|
||||
> "$NEWENV"
|
||||
;
|
||||
done < "$ENVMAP"
|
||||
|
||||
rm -- "$NEWENV.temp" "$ENVMAP" &>/dev/null
|
||||
|
||||
head -n1 -- "$NEWENV" | grep -q "^{}$" && {
|
||||
echo '---' > "$NEWENV"
|
||||
}
|
||||
|
||||
cat -- "$NEWENV" | yq
|
||||
SUCCESS "new environment saved to '$NEWENV'"
|
||||
66
.config/env.yaml
Normal file
66
.config/env.yaml
Normal file
@@ -0,0 +1,66 @@
|
||||
---
|
||||
aws:
|
||||
.DESCRIPTION: >-
|
||||
standard AWS environment variables used by awscli and other tools
|
||||
account:
|
||||
.ENVIRONMENT: AWS_ACCOUNT
|
||||
efs:
|
||||
local-mount-point:
|
||||
.DESCRIPTION: >-
|
||||
fully-qualified path to mount the EFS drive
|
||||
.ENVIRONMENT: AWS__EFS__LOCAL_MOUNT_POINT
|
||||
profile:
|
||||
.ENVIRONMENT: AWS_PROFILE
|
||||
region:
|
||||
.ENVIRONMENT: AWS_REGION
|
||||
directus:
|
||||
.DESCRIPTION: >-
|
||||
details for a directus instance
|
||||
api-token:
|
||||
.ENVIRONMENT: DIRECTUS__API_TOKEN
|
||||
base-url:
|
||||
.ENVIRONMENT: DIRECTUS__BASE_URL
|
||||
discord:
|
||||
.DESCRIPTION: >-
|
||||
details for discord bot
|
||||
bot-token:
|
||||
.ENVIRONMENT: DISCORD__BOT_TOKEN
|
||||
content-footer:
|
||||
.ENVIRONMENT: DISCORD__CONTENT_FOOTER
|
||||
content-header:
|
||||
.ENVIRONMENT: DISCORD__CONTENT_HEADER
|
||||
default-avatar-url:
|
||||
.ENVIRONMENT: DISCORD__DEFAULT_AVATAR_URL
|
||||
default-channel-id:
|
||||
.ENVIRONMENT: DISCORD__DEFAULT_CHANNEL_ID
|
||||
default-username:
|
||||
.ENVIRONMENT: DISCORD__DEFAULT_USERNAME
|
||||
default-webhook:
|
||||
.ENVIRONMENT: DISCORD__DEFAULT_WEBHOOK
|
||||
linear:
|
||||
.DESCRIPTION: >-
|
||||
linear.app project management configuration
|
||||
api-token:
|
||||
.ENVIRONMENT: LINEAR__API_TOKEN
|
||||
redis:
|
||||
.DESCRIPTION: >-
|
||||
redis connection credentials
|
||||
auth:
|
||||
.ENVIRONMENT: REDIS_AUTH
|
||||
host:
|
||||
.ENVIRONMENT: REDIS_HOST
|
||||
port:
|
||||
.ENVIRONMENT: REDIS_PORT
|
||||
twilio:
|
||||
.DESCRIPTION: >-
|
||||
twilio account / credentials
|
||||
account-sid:
|
||||
.ENVIRONMENT: TWILIO__ACCOUNT_SID
|
||||
api-key:
|
||||
.ENVIRONMENT: TWILIO__API_KEY
|
||||
api-secret:
|
||||
.ENVIRONMENT: TWILIO__API_SECRET
|
||||
default-phone-from:
|
||||
.ENVIRONMENT: TWILIO__DEFAULT_PHONE_FROM
|
||||
default-phone-to:
|
||||
.ENVIRONMENT: TWILIO__DEFAULT_PHONE_TO
|
||||
Reference in New Issue
Block a user