=====================================================================
Increased non-scwrypts-runtime compatibility and improved clarity
in user environments after sourcing the scwrypts.plugin.zsh.
--- New Features -------------------------
- added experimental support for --output json
- added 'scwrypts --list-groups' to output the SCWRYPTS_GROUPS value
- added 'scwrypts --config' to be `eval`-ed in non-scwrypts-runtime zsh
--- Changes ------------------------------
- removed config variables which pertained to old scwrypts
- removed deprecated --no-log
- cleaned up environment requirements and improved import saftey for
scwrypts.plugin.zsh; scwrypts is now *required* on $PATH in order to work
- refactored group configuration to match external group configuration
(configuration now in scwrypts.scwrypts.zsh rather than zsh/lib/config.group.zsh)
- plugins/kubectl now forces an unalias of `f` (for fluxcd) on load
- the 'use' command now supports the '-c' short flag for ease of quick
use
- upgraded max supported python version to 3.12; dropped support for
python 3.9 (>3.10 required)
- remove old references to SCWRYPTS_ROOT in favour of SCWRYPTS_ROOT__scwrypts
- SCWRYPTS_LOG_LEVEL setting is now forwarded when using the SCWRYPTS__RUN
meta execution function
=====================================================================
DEPRECATION REMINDER!
The following functions and APIS are no longer available:
- FZF_HEAD : use FZF as a drop-in replacement
- FZF_TAIL : use FZF as a drop-in replacement
- SCWRYPTS__GET_RUNSTRING__zsh_v3 : upgrade to zsh/scwrypts v4
runstrings
--- Bug Fixes ----------------------------
- removed legacy INFO references in plugins/kubectl
- the zsh-builder plugin (CTRL+Y) now show clean helpdocs (no more
visual terminal artifacts)
--- New Features -------------------------
- differentiate manual / managed versions of scwrypts in versioning;
this will prevent 'scwrypts --update' from operating against managed
installations
- created SCWRYPTS__GET_RUNSTRING__zsh__generic to provide an easy way
to write custom runstrings; this will do all the nice things default
zsh/scwrypts v4 do (multiflag separation, help flag injection, USAGE
definitions, and required MAIN() {} wrapper).
=====================================================================
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 ------------------------------
- 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
=====================================================================
--- 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')
