Release v0.149.0 Breaking changes · cloudposse/geodesic

Breaking changes

This release includes some incompatible changes in Geodesic. These changes can be reverted via customizations, a.k.a preferences and overrides. (Review the documentation on customization if needed.)

On launch, Geodesic used to start with the initial working directory set by Docker workdir. Now Geodesic tries to set your initial working directory to the same directory you launched Geodesic from, if that directory is accessible inside the container. This happens after your preferences are loaded, so if you changed directories in your preferences script(s), that change will be overriden. You can avoid this by adding export GEODESIC_WORKDIR=<your desired working directory> to your preferences, or revert it by changing directory in your overrides.
GEODISIC_PROMPT_GLYPHS was renamed GEODESIC_PROMPT_GLYPHS. You can change your customization accordingly, although we recommend reviewing the new options for customizing command line prompt appearance and considering alternatives, including installing the Noto font core.
If atmos is installed, ATMOS_BASE_PATH will be automatically set if the initial working directory appears to contain or be part of an atmos configuration tree. See cloudposse/atmos#100. You can avoid automatic configuration by explicitly setting ATMOS_BASE_PATH in your customizations
This release updates the installed kubectl 1.16 -> 1.21. Best practice is to use the version of kubectl that matches the version of Kubernetes you are using. See kubectl version skew policy for more details. We recommend not relying on the version pre-installed in Geodesic, and instead installing the specific version you need from the Cloud Posse package repo. Packages are named with the major and minor version (e.g. kubectl-1.20) and are automatically upgraded as new patches are released. If you have multiple versions installed, use update-alternaitves <option> kubectl to manage them.

New options for customizing command line prompt appearance

Click to reveal

You could previously choose between 3 sets of glyphs to be used in the Geodesic command line prompt by setting the environment variable PROMPT_STYLE to "plain" to use plan ASCII characters, "unicode" to use Unicode characters limited to the standard (not supplemental) planes of Unicode, or leave it unset (or set to anything else) to get the default set of glyphs, which notably includes '⨠' Z NOTATION SCHEMA PIPING from the "Supplemental Mathematical Operators" Unicode block. Being from the supplemental plane, it is not as widely available: for instance, it is not included in the default fonts on Ubuntu.

Our current recommendation for resolving this issue is to install a font that contains the missing character on your host. For example, for Ubuntu:

$ sudo apt update
$ sudo apt install fonts-noto-core

However, taking this as a general issue rather than just specific to Ubuntu, we have included more options.

New PROMPT_STYLE: You can now set PROMPT_STYLE=fancy to get the default set of glyphs except for the one missing from Ubuntu, which is replaced with the glyph from the "unicode" style. This should cover most cases where the default style is broken.

GEODESIC_PROMPT_GLYPHS: We previously provided a specific workaround for this by allowing you to set GEODISIC_PROMPT_GLYPHS [sic] to any string of characters you wanted to end the prompt with. In this release we fixed the spelling of that environment variable, so it is now GEODESIC_PROMPT_GLYPHS, but hopefully you will no longer need it, and you will instead choose either to install a font or switch to the "fancy" style.

Full glyph customization: You can now set each of the 4 glyphs used by the command line prompt, plus the host file system designator, individually:

ASSUME_ROLE_ACTIVE_MARK is the glyph to show when you have AWS credentials active. Defaults to a green, bold, '√' SQUARE ROOT (looks like a check mark): $'\u221a'
ASSUME_ROLE_INACTIVE_MARK is the glyph to show when you do not have AWS credentials active. Defaults to a red, bold, '✗' BALLOT X: $'\u2717'
BLACK_RIGHTWARDS_ARROWHEAD is the glyph at the end of the prompt. The troublesome default is '⨠' Z NOTATION SCHEMA PIPING: $'\u2a20'
BANNER_MARK is the glyph at the start of the first line of a 2-line prompt that introduces the BANNER text. Defaults to '⧉', TWO JOINED SQUARES: $'\u29c9'
PROMPT_HOST_MARK is added to the command line when the current working directory is on the host computer (via a bind mount) and not in the container. Defaults to '(HOST)' with "HOST" in red bold. Disable this feature by setting export PROMPT_HOST_MARK="".

You can now set any of these in your standard customizations and your setting will be used.

Cautions:

You can set these variables to multiple characters, and use ANSI escape codes to change their colors, but in order for command line editing to continue to work properly, any non-printing characters must be escaped. We have had the best luck with starting the escape with $'\x01' and ending it with $'\x02', but there a couple of other, similar options. If you fail to do this, or do it incorrectly, your cursor will be incorrectly positioned when you edit a command line from your history and what you see will not be what is executed.
Command line editing can also be affected by "ambiguous width characters". Unicode characters can be "narrow" or "wide" or "ambiguous". In practice in Roman (e.g. English) scripts, a "wide" character takes up the space of 2 "narrow" characters, and the standard Roman letters are all narrow. In older versions of Unicode, many Emoji are ambiguous width. If you use an ambiguous width character that prints wide but is interpreted as narrow, command line editing will suffer from incorrect cursor placement, as with non-printing characters above. This can be worked around by finding and selecting a preference such as "Treat ambiguous characters as wide" (if you can find such a preference), but we recommend just avoiding characters that cause problems.

🚀 Enhancements

Start in host CWD, autoconfigure ATMOS_BASE_PATH @Nuru (#756)

what

When starting Geodesic, set the initial working directory to the Host's current working directory, if it is accessible
If the initial working directory appears to be part of an atmos configuration, set ATMOS_BASE_PATH accordingly
Allow fine-grained customization of command line prompt
Update kubectl 1.16 -> 1.21
Update Google Cloud SDK 352.0.0 -> 369.0.0
Update Debian 10.10 -> 10.11
Update Python3 on Debian 3.8.11 -> 3.8.12
Update Alpine 3.13.5 -> 3.13.7 (Python3 3.8.10 dictated by Alpine package repo)