Merge pull request #410 from opencybersecurityalliance/develop

1.8.0
opencybersecurityalliance · Oct 19, 2023 · f4bccfc · f4bccfc
2 parents c7f911a + bfbdfc6
commit f4bccfc
Show file tree

Hide file tree

Showing 16 changed files with 30 additions and 58 deletions.
diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml
@@ -35,6 +35,7 @@ jobs:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
         run: |
-          build --sdist --wheel --outdir dist/ .
+          # `build` is installed as a Python module, not a standalone commandline
+          python -m build --sdist --wheel --outdir dist/ .
           twine check dist/*
           twine upload --verbose dist/*
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -6,63 +6,23 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog`_.
 
-2023-10-18
-==========
-
-kestrel_core 1.8.0
-------------------
+1.8.0 (2023-10-18)
+==================
 
 Added
-^^^^^
+-----
 
 - Hide credentials in debug log
 - Type checking in kestrel/utils.py
+- Merge ``opencybersecurityalliance/kestrel-jupyter`` repo into this repo as the umbralla package for Kestrel
 
 Changed
-^^^^^^^
+-------
 
 - Package name from ``kestrel-lang`` to ``kestrel-core`` to peel off components into standalone packages
-- Installation documentation
-
-kestrel_jupyter 1.8.0
----------------------
-
-Added
-^^^^^
-
-- Merge ``opencybersecurityalliance/kestrel-jupyter`` repo into this repo as the umbralla package for Kestrel
-
-kestrel_datasource_stixbundle 1.8.0
------------------------------------
-
-Added
-^^^^^
-
-- Establish standalone package with its own ``pyproject.toml``
-
-kestrel_datasource_stixshifter 1.8.0
-------------------------------------
-
-Added
-^^^^^
-
-- Establish standalone package with its own ``pyproject.toml``
-
-kestrel_analytics_python 1.8.0
-------------------------------
-
-Added
-^^^^^
-
-- Establish standalone package with its own ``pyproject.toml``
-
-kestrel_analytics_docker 1.8.0
-------------------------------
-
-Added
-^^^^^
-
-- Establish standalone package with its own ``pyproject.toml``
+- Establish two standalone datasource interface packages
+- Establish two standalone analytics interface packages
+- Update installation documentation
 
 1.7.6 (2023-09-25)
 ==================

diff --git a/GOVERNANCE.rst b/GOVERNANCE.rst
@@ -51,24 +51,23 @@ A maintainer should release a new Kestrel runtime (PyPI package name: ``kestre-l
     #. Sync the local git repo to the latest of the ``develop`` branch.
     #. Update the ``version`` field in ``packages/*/pyproject.toml`` for any package that has been updated.
     #. Update dependencies in ``packages/*/pyproject.toml``.
-    #. Always bump the ``version`` field in ``packages/kestrel_jupyter/pyproject.toml`` (the umbralla package).
-    #. Add changes in ``CHANGELOG.rst`` under a new date section.
-    #. Add changes of each package under a new version subsection of the date section.
+    #. Always bump the ``version`` field in ``packages/kestrel_jupyter/pyproject.toml`` (the umbrella package).
+    #. Add changes in ``CHANGELOG.rst`` under the umbrella package version.
     #. Add new contributors to ``AUTHORS.rst`` if any.
-    #. Commit the updates with ``<date> NIGHTLY`` as the message.
+    #. Commit the updates with the umbrella package version as the message.
     #. Push the local ``develop`` branch to remote.
 
 #. Graduate code to the ``release`` branch
 
-    #. Open a PR to merge the ``develop`` branch to the ``release`` branch. Use ``<date> TO RELEASE`` as the PR title.
+    #. Open a PR to merge the ``develop`` branch to the ``release`` branch. Use umbrella package version as the PR title.
 
     #. Merge the PR.
 
 #. Create a new release
 
     #. Go to the release page and click *Draft a new release*.
 
-    #. Type the version number as the new tag to create.
+    #. Type the umbrella package version number as the new tag to create.
 
     #. Choose ``release`` branch as the *Target*.
 

diff --git a/docs/installation/runtime.rst b/docs/installation/runtime.rst
@@ -131,7 +131,7 @@ any newly opened terminal.
 
         .. code-block:: console
 
-            $ pip install kestrel_jupyter
+            $ pip install kestrel-jupyter
             $ kestrel_jupyter_setup
 
     .. tab-item:: Nightly Built
@@ -179,7 +179,7 @@ invoke any of them:
 
         - Start a Kestrel session in Python directly. See more at :doc:`../source/kestrel.session`.
 
-        - Use `magic command`_ in iPython environment. Check `kestrel_jupyter`_ package for usage.
+        - Use `magic command`_ in iPython environment. Check `kestrel-jupyter`_ package for usage.
 
 What's to Do Next
 =================
@@ -193,7 +193,7 @@ What's to Do Next
 .. _Python virtual environment: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/
 .. _Xcode: https://developer.apple.com/xcode/
 .. _kestrel-lang: http://github.com/opencybersecurityalliance/kestrel-lang
-.. _kestrel_jupyter: http://github.com/opencybersecurityalliance/kestrel-jupyter
+.. _kestrel-jupyter: http://github.com/opencybersecurityalliance/kestrel-jupyter
 .. _firepit: http://github.com/opencybersecurityalliance/firepit
 .. _Jupyter Notebook: https://jupyter.org/
 .. _magic command: https://ipython.readthedocs.io/en/stable/interactive/magics.html

diff --git a/packages/kestrel_analytics_docker/README.rst b/packages/kestrel_analytics_docker/README.rst
@@ -0,0 +1 @@
+../../README.rst
diff --git a/packages/kestrel_analytics_docker/pyproject.toml b/packages/kestrel_analytics_docker/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "kestrel_analytics_docker"
 version = "1.8.0"
 description = "Kestrel Docker Analytics Interface"
+readme = "README.rst"
 requires-python = ">=3.8"
 license = {text = "Apache 2.0 License"}
 maintainers = [

diff --git a/packages/kestrel_analytics_python/README.rst b/packages/kestrel_analytics_python/README.rst
@@ -0,0 +1 @@
+../../README.rst
diff --git a/packages/kestrel_analytics_python/pyproject.toml b/packages/kestrel_analytics_python/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "kestrel_analytics_python"
 version = "1.8.0"
 description = "Kestrel Python Analytics Interface"
+readme = "README.rst"
 requires-python = ">=3.8"
 license = {text = "Apache 2.0 License"}
 maintainers = [

diff --git a/packages/kestrel_core/README.rst b/packages/kestrel_core/README.rst
@@ -0,0 +1 @@
+../../README.rst
diff --git a/packages/kestrel_core/pyproject.toml b/packages/kestrel_core/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "kestrel_core"
 version = "1.8.0"
 description = "Kestrel Threat Hunting Language"
+readme = "README.rst"
 requires-python = ">=3.8"
 license = {text = "Apache 2.0 License"}
 maintainers = [

diff --git a/packages/kestrel_datasource_stixbundle/README.rst b/packages/kestrel_datasource_stixbundle/README.rst
@@ -0,0 +1 @@
+../../README.rst
diff --git a/packages/kestrel_datasource_stixbundle/pyproject.toml b/packages/kestrel_datasource_stixbundle/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "kestrel_datasource_stixbundle"
 version = "1.8.0"
 description = "Kestrel STIX-bundle Datasource Interface"
+readme = "README.rst"
 requires-python = ">=3.8"
 license = {text = "Apache 2.0 License"}
 maintainers = [

diff --git a/packages/kestrel_datasource_stixshifter/README.rst b/packages/kestrel_datasource_stixshifter/README.rst
@@ -0,0 +1 @@
+../../README.rst
diff --git a/packages/kestrel_datasource_stixshifter/pyproject.toml b/packages/kestrel_datasource_stixshifter/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "kestrel_datasource_stixshifter"
 version = "1.8.0"
 description = "Kestrel STIX-shifter Datasource Interface"
+readme = "README.rst"
 requires-python = ">=3.8"
 license = {text = "Apache 2.0 License"}
 maintainers = [

diff --git a/packages/kestrel_jupyter/README.rst b/packages/kestrel_jupyter/README.rst
@@ -0,0 +1 @@
+../../README.rst
diff --git a/packages/kestrel_jupyter/pyproject.toml b/packages/kestrel_jupyter/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "kestrel_jupyter"
 version = "1.8.0"
 description = "Kestrel Jupyter Kernel"
+readme = "README.rst"
 requires-python = ">=3.8"
 license = {text = "Apache 2.0 License"}
 maintainers = [