yage
a739d3b5a2
=====================================================================
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)
Meta Scwrypts
The fastest way to configure scwrypts is through scwrypts! The ZSH scripts in this library are used to manage Scwrypts artifacts.
Configure
Great for first-time setup!
It is simple to edit the local dot-config and restart your terminal.
It is much faster to hit CTRL+W and select config/edit through a fuzzy search.
This will immediately open your custom configuration file and reload any necessary resources on save.
Environment
If you use Scwrypts, you should use these commands all the time. This is your gateway to managing scwrypts sandboxed environments.
| Command | Description |
|---|---|
edit |
edit an existing environment |
copy |
create and edit a new environment from an existing one |
delete |
permanently delete an environment by name |
stage-variables |
stage missing variables; helpful for non-ZSH scwrypts |
synchronize |
uses template to add missing and remove extemporaneous variables |
Environment Inheritance
You can make a child environment by naming an environment <parent-name>.<child-name>.
Children inherit all parent-set values, and parent-set values overwrite child-set values.
Remember that synchronize runs every time you edit an environment, so changes propagate to children immediately.
Inherited values are denoted by # from <parent-name> in the environment file.
Nested children will inherit values from all parents.
Special Environment Variable Syntax
All environment variables which end in __[a-z_]+ are ignored by the template file.
These environment variables will propagate to children, but will not be removed nor staged into the .env.template.
__select Environment Variables
Omit any variable, but provide a comma-separated list with the __select suffix, and the user will be prompted to select a value from the provided options.
In the following configuration, the user will be prompted to select an AWS_REGION once at the beginning of scwrypt execution:
export AWS_REGION=
export AWS_REGION__select=us-east-1,us-east-2,us-west-1,us-west-2
Setting the AWS_REGION variable will cause scwrypts to ignore the __select syntax.
CI will fail on select, because CI fails on any FZF prompt.
__override Environment Variables
Override any variable with the indicated value. This will take precedence over existing values and any other special environment variable types.
Examples of use:
- temporarily changing a single value in your current session (e.g.
export VARIABLE__override=value) - overriding a variable for a one-time command (e.g.
VARIABLE__override=value scwrypts ...)
Logs
Quickly view or clear Scwrypts logs.
Virtualenv
In addition to the custom environment sandbox, scwrypts will load the appropriate virtual environment for the current script.
Update / create the environment with update-all.
Drop and recreate the environment with refresh.