Release 0.10.0

- Tag line: It's about time!
Kintyre · Mar 3, 2023 · cec3615 · cec3615
1 parent 6a20a2c
commit cec3615
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 15 deletions.
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -21,23 +21,24 @@ Ksconf 0.10
    The :py:class:`~ksconf.command.combine.CombineCmd` now contains only the command line functionality.
 
 
-Ksconf v0.10.0 (DRAFT)
-~~~~~~~~~~~~~~~~~~~~~~~
+Ksconf v0.10.0 (2023-03-03)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-**Hishglights:**
 
-*  Ksconf v0.10 and later requires Python 3.7 or newer.
-   If you need Python 2.7 or 3.6 support, please stick with the latest 0.9.x release.
+**Highlights:**
+
 *  The official Python package was renamed ``ksconf``.
-   The ``kintyre-splunk-conf`` package continue to be released in parallel at least until version 1.0.
-   You can continue updating the ``kintyre-splunk-conf`` package and it will install the ``ksconf`` package as a dependency.
+   The ``kintyre-splunk-conf`` package will continue to be released in parallel at least until version 1.0.
+   You can continue updating and using the ``kintyre-splunk-conf`` package but eventually startup warnings will be added to remind users to switch.
+*  Ksconf v0.10 and later requires Python 3.7 or newer.
+   If you need Python 2.7 or 3.6 support, please stick with the latest 0.9.x release of ``kintyre-splunk-conf``.
 *  The KSCONF acronym has taken on a new meaning.
    Originally, meaning *Kintyre's Splunk CONFiguration tool*,
    now becomes a recursive acronym:  *Ksconf Splunk CONFiguration tool*.
    Kintyre has been acquired by CDI LLC, and this option seemed least intrusive.
 *  Add support Dashboard Studio dashboards.
    The JSON blobs inside of Simple XML payloads can now be formatted too.
-   Multiline searches are stiff difficult to diff, but it should be better than before.
+   Multiline searches are still difficult to diff, but there's no way to fix that while using JSON.
 
 
 More changes:
@@ -57,7 +58,7 @@ Bug fixes:
 
 *  Fixed ``sort`` bug where the user was incorrectly told that a file with errors was unexpectedly also successfully replaced.
    The contradictory output messages have been cleaned up.
-   For clarity, this only occurred for inline replacement mode, and was purely an output issue, not a file handling problem.
+   For clarity, this only occurred for inline replacement mode, and was purely a reporting issue, not a file handling problem.
 *  Fixed compatibility issues with ``rest-publish`` command and the splunk-sdk library around data type expectations.
    A big thanks to bayeslearner (`#95 <https://github.com/Kintyre/ksconf/issues/95>`__) for the fix.
    If you run into any issues, try upgrading your version of ``splunk-sdk``.

diff --git a/docs/source/dyn/ksconf_subcommands.csv b/docs/source/dyn/ksconf_subcommands.csv
@@ -7,6 +7,7 @@
 :ref:`ksconf package <ksconf_cmd_package>`,alpha,Create a Splunk app .spl file from a source directory
 :ref:`ksconf promote <ksconf_cmd_promote>`,beta,"Promote .conf settings between layers using either batch or interactive mode.  Frequently this is used to promote conf changes made via the UI (stored in the ``local`` folder) to a version-controlled directory, such as ``default``. "
 :ref:`ksconf rest-export <ksconf_cmd_rest-export>`,beta,Export .conf settings as a curl script to apply to a Splunk instance later (via REST)
+:ref:`ksconf rest-publish <ksconf_cmd_rest-publish>`,alpha,Publish .conf settings to a live Splunk instance via REST
 :ref:`ksconf snapshot <ksconf_cmd_snapshot>`,alpha,Snapshot .conf file directories into a JSON dump format
 :ref:`ksconf sort <ksconf_cmd_sort>`,stable,Sort a Splunk .conf file creating a normalized format appropriate for version control
 :ref:`ksconf unarchive <ksconf_cmd_unarchive>`,beta,Install or upgrade an existing app in a git-friendly and safe way

diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
 entrypoints
-splunk-sdk
+splunk-sdk>=1.7.0
 
 lxml>=4.6.5
diff --git a/setup.py b/setup.py
@@ -12,12 +12,13 @@
 package_name = "kintyre-splunk-conf" if os.getenv("BUILD_OLD_PACKAGE") == "1" else "ksconf"
 
 if package_name == "ksconf":
-    package_rename_message = "This package was previously called `kintyre-splunk-conf` prior to v0.10.0"
+    package_rename_message = "Earlier version of this project were packaged as " \
+        "[kintyre-splunk-conf](https://pypi.org/project/kintyre-splunk-conf) prior to v0.10.0"
 else:
     package_rename_message = dedent(f"""
     ## Package rename
     This package has been renamed [ksconf](https://pypi.org/project/ksconf/) starting with v0.10.
-    Please switching to this new package using the upgrade steps listed below.
+    Please switch to this new package using the upgrade steps listed below.
 
     ## Suggested upgrade steps:
     ```sh
@@ -27,8 +28,7 @@
 
     ## Who should keep using {package_name}?
     For the time being, you can still install and upgrade the latest release of
-    ksconf using the `{package_name}` package.  Expect annoying startup messages
-    at or near the 0.11 release!
+    ksconf using the `{package_name}` package.
 
     Note that as of the v0.10 release, only Python 3.7 and higher are supported.
     If you need a version of ksconf that works with Python 2.7 & Python 3.6,
@@ -168,7 +168,7 @@ def get_ver():
       extras_require={
           "bash": ["argcomplete"],
           "thirdparty": [
-              "splunk-sdk"
+              "splunk-sdk>=1.7.0"
           ],
       },
       include_package_data=True,