Ksconf

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Fixed bug where empty stanzas could be removed from ``.conf`` files.
This can be detrimental for ``capability::*`` entries in ``authorize.conf``, for example.
A big thanks to nebffa for tracking down this bug!

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- New automatic ``promote`` mode is now available using CLI arguments!
This allows stanzas to be selected for promotion from the CLI in batch and interactive modes.
This implementation borrows (and shares code) with the ``ksconf filter`` command so hopefully the CLI arguments look familiar.
It's possible to promote a single stanza, a stanza wildcard, regex or invert the matching logic and promote everything except for the named stanza (blocklist).
Right now ``--stanza`` is the only supporting matching mode, but more can be added as needed.
A huge thanks to mthambipillai for providing a pull-request with an initial implementation of this feature!
- Added a new summary output mode (``ksconf promote --summary``) that will provide a quick summary of what content could be promoted.
This can be used along side the new ``--stanza`` filtering options to show the names of stanzas that can be promoted.
- Replaced insensitive terminology with race-neutral terms. Specifically the terms 'blacklist' and 'whitelist' have been replaced.
NOTE: This does *not* change any CLI attributes, but in a few cases the standard output terminology is slightly different.
Also terminology in ``.conf`` files couldn't be updated as that's controlled by Splunk.
- Fixed bug in the ``unarchive`` command where a ``locale`` folder was blocked as a ``local`` folder and where a nested ``default`` folder (nested under a Python package, for example) could get renamed if ``--default-dir`` was used, now only the top-most ``default`` folder is updated.
Also fixed an unlikely bug triggered when ``default/app.conf`` is missing.
- Fixed bug with ``minimize`` when the required ``--target`` argument is not given. This now results in a reminder to the user rather than an unhandled exception.
- Splunk app packaging fix. Write access to the app was previously not granted due to a spelling mistake in the metadata file.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Added new ``--follow-symlink`` option to the ``combine`` command so that input directory structures with symbolic links can be treated the same as proper directories.
- Corrected Windows issue where wildcard (glob) patterns weren't expanded by for ``check`` and ``sort``. This is primarily a difference in how a proper shells (e.g., bash, csh, zsh) handle expansion natively vs CMD on Windows does not. However, since this is typically transparently handled by many CLI tools, we'll follow suite. (BTW, running ksconf from the GIT Bash prompt is a great alternative.) Only the most minimalistic expansion rules will be available, (so don't expect ``{props,transforms,app}.conf`` to work anytime soon), but this should be good enough for most use cases. Thanks to SID800 for reporting this bug.
- Fixed issues with the ``unarchive`` command when ``git`` is not installed or an app is being unarchived (installed/upgrade) into a location not managed by Git. Note that additional output is now enabled when the ``KSCONF_DEBUG`` environmental variable is set (in lieu of a proper verbose mode). Bug report provided by SID800.
- Enhanced ``ksconf --version`` output to include Git executable path and version information; as well as a platform dump. (Helpful for future bug reporting.)
- Added feature to disable the marker file (safety check) automatically created by the ``combine`` command for use in automated processing workflows.
- Updated ``pre-commit`` documentation and sample configurations to use ``rev`` rather than ``sha`` as the means of identifying upstream tags or revisions. Recent releases of ``pre-commit`` will warn you about this during each run.
- Fixed a temporary file cleanup issue during certain in-place file replacement operations. (If you found any unexpected ``*.tmp`` files, this could have been the cause.)

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Fresh review and cleanup of all docs! (A huge thank you to Brittany Barnett for this massive undertaking)
- Fixed unhandled exception when encountering a global stanza in metadata files.
- Expand some error messages, sanity checks, and added a new session token (``--session-key``) authentication option for ``rest-publish``.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Fixed a long-term bug where the diff output of a single-line attribute change was incorrectly represented in the textual output of 'ksconf diff' and the diff output in other commands. This resolves a combination of bugs, the first half of which was fixed in 0.7.3.
- Allow ``make_docs`` script to run on Windows, and other internal doc build process improvements.

~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Inline the ``six`` module to avoid elusive bootstrapping cases where the module couldn't be found.
This primarily impacts ``pre-commit`` users.
The ``ksconf.ext.*`` prefix is being used for this, and any other inlined third party modules we may need in the future.
- Other minor docs fixes and internal non-visible changes.