=====================================================================
Big day! V4 is finally live. This INCLUDES some BREAKING CHANGES to ZSH
TYPE scwrypts! Please refer to the readme for upgrade details
(more specifically docs/upgrade/v3-to-v4.md)
Upgrade is SUPER EASY, so please take the time to do so.
--- New Features ----------------------------------------------------
- zsh type scwrypts have an upgraded runstring to improve context setup
and simplicity to the scwrypt-writer
- scwrypts now publishes the package (scwrypts) to PyPi; this provides a
simple way to invoke scwrypts from python-based environments as well
as the entire scwrypts python library suite
pip install scwrypts
- scwrypts now publishes the package (scwrypts) to npm; this provides a
simple way to invoke scwrypts from nodesjs environments
npm install scwrypts
--- Bug Fixes -------------------------------------------------------
- scwrypts runner prompts which use the zshbuiltin "read" now
appropriately read input from tty, pipe, files, and user input
- virtualenv refresh now loads and prepares the scwrypts virtual
environments correctly
--- Changes ---------------------------------------------------------
- created the (-v, --log-level) scwrypts arguments as improvements of
and replacements to the --verbose and --no-log flags
- (-n) is now an alias for (--log-level 0)
- (--no-log) is the same as (-n) for compatibility, but will be removed in 4.2
- zsh/lib/utils/io print functions now *interact with log-level* various
log levels will now only display the appropriate console prints for
the specified log level
- zsh/lib/utils/io:INFO has been renamed to DEBUG to align with
log-level output; please use DEBUG for debug messages and REMINDER for
important user messages
- created zsh/lib/utils/io:FZF_USER_INPUT as a *drop-in replacement* for
the confusing FZF_HEAD and FZF_TAIL commands. Update by literally
changing any instances of FZF_HEAD or FZF_TAIL with FZF_USER_INPUT
- FZF_HEAD and FZF_TAIL will be removed in 4.2
- zsh/lib/utils/io:READ (and other zshbuiltin/read-based prompts) now
accept a --force-user-input flag in case important checks should
require an admin's approval. This flag will ensure that piped input
and the `scwrypts -y` flag are ignored for the single prompt.
- zsh/lib/utils/color has been updated to use color names which match
the ANSI color names
- zsh/hello-world has been reduced to a minimal example; this is to
emphasize ease-of-use with v4
- zsh/sanity-check is a scwrypts/run testing helper and detailed
starting reference (helpful since hello-world is now minimal)
- various refactor, updates, and improvements to the scwrypts runner
- migrated all zsh scwrypts and plugins to use v4 runner syntax
- zsh
- plugins/kubectl
- plugins/ci
- refactored py/lib into py/lib/scwrypts (PyPi)
=====================================================================
--- Changes ------------------------------
- Moved personal-environment specific scwrypts to wrynegade/dotwryn
=====================================================================
--- Changes ------------------------------
- scwrypts runner has new arguments
-q/--quiet allows quiet-mode operation while still logging to logfiles
-v/--verbose forces verbose mode
--version longform required (-v is now for "verbose" mode)
- scwrypts runner now auto-detects certain CLI usage, running in quiet,
logged mode if pattern match successfully identifies a single scwrypt
(or when using --name); use --verbose to override this behavior
- 'k exec' no longer requires double '--' if a '--' comes after
- old : k exec -it my-pod-0 -- -- /bin/sh
+ new : k exec -it my-pod-0 -- /bin/sh
+ still works : k -- exec -it my-pod-0 -- /bin/sh
--- Bug Fixes ----------------------------
- fixed various plugins/kubectl auto-completion settings; arguments
after '--' or profile number (e.g. 'k 1 get deployments') will now
appropriately autocomplete in the indicated profile
- helm template functions now work on related .tpl files as well
(renders from chart root)
- fixed some goofy UTF-8 icons in zsh/lib/utils/io
--- New Features -------------------------
- (experimental) scwrypts zsh plugin for interactive command selection
(like CTRL+SPACE), but allows you to build command arguments,
providing help dialogue for the selected command
--- New Scripts --------------------------
- zsh/misc/tally ) helps keep tally-counts of things; helpful when
running long scripts "what iteration am I on"
=====================================================================
--- Changes ------------------------------
- kubectl driver updates; getting better, but still need to fix
autocomplete in certain circumstances
- added -y|--yes flags to scwrypts to auto-accept user-prompts (use with
caution)
- figured out the whole mikefarah/yq vs kislyuk/yq thing; use YQ for
compatiblity
--- Bug fixes ----------------------------
- helm template generation now loads values in a more appropriate order
which prevents overwrite by the wrong values file
=====================================================================
--- New Features -------------------------
- --list-envs now shows all available environments
=====================================================================
--- New Features -------------------------
- GitHub Actions now autodetects groups within the "$GITHUB_WORKSPACE"
=====================================================================
--- New Features -------------------------
- adding variables of the format `^SCWRYPTS_GROUP_LOADERS__[a-z_]\+=`
will let those files be explicitly sourced during run (this should
allow custom group usage in CI)
=====================================================================
--- Changes ------------------------------
- Helm template generation looks for default values in file://
dependencies in addition to the standard values locations
- vundle installer now *actually installs Vundle.vim* if it is missing
=====================================================================
--- New Features -------------------------
- Github Actions integration from 3.7.0 and up!
```yaml
# try it out in gh actions
- uses: wrynegade/scwrypts@main
with:
version: v3.7.0
scwrypt: --name hello-world --group scwrypts --type py
args: --message "hello from github actions ci <3"
```
--- New Scripts --------------------------
zsh/helm )
smart helm template functions (simply pass a filename)
- get-template
- update-dependencies
--- Changes ------------------------------
- CHECK_ENVIRONMENT now uses proper argument parsing
- scwrypts/plugins loaded by setting in config or environment:
SCWRYPTS_PLUGIN_ENABLED__plugin=1
- SCWRYPTS__GET_PATH_TO_RELATIVE_ARGUMENT was missed in the v2->v3
refactor and has now been reincluded as SCWRYPTS__GET_REALPATH
=====================================================================
--- Changes ------------------------------
- Allow CI more leniency in preparing aws environment
=====================================================================
--- Bug fixes ----------------------------
- Some exit error cases were not handled properly by the default eval
string due to early exit failing within the primary subshell of the
scwrypt; moving the runstring one subshell deeper allows the capture
of exit cases
=====================================================================
--- Changes ------------------------------
- Adjusted USAGE (from zsh/lib/utils/io.zsh) to allow dynamic variable
insertion in help dialogues by setting USAGE__<help-group> and using
the syntax listed
- Various quality-of-life changes and and fixes to experimental kubectl
plugin
--- Bug fixes ----------------------------
- sourcing 'scwrypts.plugin.zsh' no longer sets __SCWRYPT=1 in your
current environment
=====================================================================
--- New Features -------------------------
- Introducing an optional plugin for `kubectl` facilitation! Check out
'plugins/kubectl/README.md' for more details.
--- Changes ------------------------------
- The function which lists all available scwrypts now ignores
directories with a top-level base called "plugins." If this is a name
conflict, you will need to define your own
`SCWRYPTS__LIST_AVAILABLE_SCWRYPTS__<group>` function!
(ref the changes in 'zsh/lib/scwrypts/run.module.zsh')
=====================================================================
--- Changes ------------------------------
- AWS (the cli wrapper) now checks for it's required variables *on run*.
This accomodates scwrypts which may need to run in multiple regions,
but make the downstream scwrypt responsible for adding AWS_REGION to
the REQUIRED_ENV list!
- Got rid of all kinds of hackiness surrounding postgres password evals
between both the postgres library and the rds library
--- Bug Fixes ----------------------------
- scwrypts --update now pulls tags for proper versioning
=====================================================================
--- Changes ------------------------------
- Allow the group variable `REQUIRED_ENVIRONMENT_REGEX` to enforce that
only some environments can run within the group
=====================================================================
--- Bug Fixes ----------------------------
- load static config files in all scwrypts contexts; not just groups
=====================================================================
--- Bug Fixes ----------------------------
- when using color, display properly in fzf
=====================================================================
--- Bug Fixes ----------------------------
- fixed a bug with creating environment files for new scwrypts groups
=====================================================================
--- Changes ------------------------------
- system/config/symlink )
now copies the existing config from the current system if
the "source" config does not exist (init from local)
- allowed implementation of group-custom scwrypt listing function
GET_AVAILABLE_SCWRYPTS__<group-name>
--- Bug Fixes ----------------------------
- fixed a bug where custom runstring operators were ignored
=====================================================================
--- Changes ------------------------------
- split up environment files per scwrypts group
- updated i3/launch-or-show to provide some new options
--- Bug Fixes ----------------------------
- utils/io commands like 'STATUS' no longer throw errors '%' characters
- fixed ERROR_CHECK function calls to CHECK_ERRORS
=====================================================================
--- Changes ------------------------------
- improved capability of py/discord/post-message to include username
flag, and defaults for each value in env config
=====================================================================
--- Bug fixes ----------------------------
- interactive scripts work again
- color works on zx again
=====================================================================
--- Bug fixes ----------------------------
- fixed variable reference in media-sync
- fixed bug with multi-line list environment variables sometimes gets
appended to a previous variable line
=====================================================================
Notice the major version change which comes with breaking changes to
2.x! Reconstructs "library" functions for both python and zsh scwrypts,
with changes to virtualenv naming conventions (you'll need to refresh
all virtualenv with the appropriate scwrypt).
--- Changes ------------------------------
- changed a naming convention across zsh scripts, particularly
removing underscores where there is no need to avoid naming clash
(e.g. 'zsh/lib/utils/io.zsh' renames '__STATUS' to 'STATUS')
- moved clients reliant on py.lib.http to the py.lib.http module
- python scripts now rely on py.lib.scwrypts.execute
- updated package.json in zx scripts to include `type = module`
- 'scwrypts --list' commandline argument now includes additional
relevant data for each scwrypt
- environment variables no longer add themselves to be staged in the
'.env.template'
--- New Features -------------------------
- new 'use' syntax for disjoint import within zsh scripts; took me
a very long time to convince myself this would be necessary
- introduced scwrypt "groups" to allow portable module creation;
(i.e. ability add your own scripts from another repo!)
- py.lib.scwrypts.io provides a combined IO stream for quick, hybrid
use of input/output files and stdin/stdout
- py.lib.fzf provides a wrapper to provide similar functionality to
zsh/utils/io.zsh including fzf_(head|tail)
- improved efficiency of various scwrypts; notably reducing runtime
of scwrypts/environment sync
- improved scwrypts CLI by adding new options for exact scwrypt
matching, better filtering, and prettier/more-detailed interfaces
--- New Scripts --------------------------
- py/twilio )
basic SMS integration with twilio
- send-sms
- py/directus )
interactive directus GET query
- get-items
- py/discord )
post message to discord channel or webhook
- post-message
=====================================================================
--- Changes ------------------------------
- python library functions moved to `py/lib`
- python scwrypts renamed in kebob-case to help prevent import
- __name__ == '__main__' enforced on all python scwrypts
--- New Features -------------------------
- `__override` variables now allow values to be force-overwritten
- py.lib.http.client provides a slim `requests.request` wrapper
--- New Scripts --------------------------
py/data/convert )
quick data converters
- csv-to-json
- csv-to-yaml
- json-to-csv
- json-to-yaml
- yaml-to-csv
- yaml-to-json
py/linear )
uses the linear.app graphql API for PM tasks
- comment
--- Bug Fixes ----------------------------
- `scwrypts` handles arguments with quotes and special characters
=====================================================================
--- Bug fixes ----------------------------
- s3/media-sync/push now pushes (instead of pull -- oops!)
- fixed a typo in the launch-or-show help
- environment actions no longer overwrite overwrite symlinks
=====================================================================
--- Bug fixes ----------------------------
- VARIABLE__select actually sets the variable value after selection
=====================================================================
--- Bug fixes ----------------------------
- i3/create-local-font-override uses the correct variables for the
correct settings now
=====================================================================
--- New Scripts --------------------------
- i3 window manager scrypts (see --help for more info)
- zsh/i3/create-local-font-override
- zsh/i3/launch-or-show
--- New Features -------------------------
Now support `__select` syntax in environment files!
(see zsh/scwrypts/README.md for more detail)
--- Changes ------------------------------
- moved some rogue configuration files under the scwrypts config
- ~/.vim/bundle/build.zsh >> ~/.config/scwrypts/vundle.zsh
- ~/.config/scwrypts/config.dotfile.zsh >> ~/.config/scwrypts/dotfiles.zsh
- __FZF, __FZF_TAIL, and __FZF_HEAD now create prompt+response logs
--- Bug Fixes ----------------------------
- zsh/config/symlinks
- don't fail when trying to symlink a directory
- no longer fails when trying to replace a broken symlink
- scwrypts now detects environments which are symlinked
- USAGE syntax now correctly shows the position of the '--' argument
delimiter
support __select in env files; ignore __lower_case suffix in env files; put blank line before comments in env files
added i3 scripts
=====================================================================
--- Bug Fixes ----------------------------
- __READ and __EDIT no longer fail on CI, just skip
=====================================================================
--- Bug Fixes ----------------------------
- git/package/install didn't create build dir if it did not exist
