From 062451f814905fe6a27ca8f5c3855479e38b162a Mon Sep 17 00:00:00 2001 From: Jared O'Neal Date: Wed, 5 Aug 2026 09:18:19 -0500 Subject: [PATCH 1/2] (Issue #51) Lessons learned from executing release process. This includes matching use of middle initials in LICENSE to uses in other attributions throughout the repo. --- LICENSE | 2 +- docs/release_procedure.rst | 22 +++++++++++++++------- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/LICENSE b/LICENSE index 27b919d..3ab57b5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2025 Matthew T. Pratola and John Yannotty +Copyright (c) 2025 Matthew T. Pratola and John C. Yannotty Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/release_procedure.rst b/docs/release_procedure.rst index a637a66..0a0652d 100644 --- a/docs/release_procedure.rst +++ b/docs/release_procedure.rst @@ -71,6 +71,8 @@ Once all tasks have been executed * Check links * Confirm that main README is consistent with Python package README and landing page of Sphinx docs + * Check contents of Python package README compatible with PyPI by executing + `twine check `. * Review all documentation associated with the repository including examples to determine if any updates still need to be made and address on a feature branch @@ -92,17 +94,20 @@ When a particular commit on ``main`` is to be deemed a release, included in the release #. Perform any review of the artifacts created by the actions deemed necessary based on the changes included in the release -#. Tag the release commit with the name ``vX.Y.Z`` and push. This will trigger - the ``test_py_sdist`` GitHub action, which builds the source distribution - with the correct version identifier and tests it. +#. Tag the release commit with the name ``vX.Y.Z`` and push. +#. Create and publish a release with the correct tag ``vX.Y.Z`` and indicate if + the release included changes to the C++ command line tools, the Python + package, the R package, or some combination of these. This will trigger the + ``test_py_sdist`` GitHub action, which builds the source distribution with + the correct version identifier and tests it. #. Confirm that the action passed with no errors or warnings. Review the action's log. -#. Create a **draft** release with the correct tag ``vX.Y.Z`` and indicate if - the release included changes to the C++ command line tools, the Python - package, the R package, or some combination of these. #. Carry out all necessary checks for the different software products (see below). -#. Change the state of the release to **publish**. + * TODO: If issues are found that require a new commit, the tag can be + reassigned to a new commit (extra effort to force update of tag in remote + and for other developers to move tag in their clones as well?). After + that, the release should be XYZ? Command line tools ^^^^^^^^^^^^^^^^^^ @@ -161,6 +166,9 @@ Otherwise, #. Review the package's webpage on PyPI. #. In a clean virtual environment, follow the installation guide for installing from |pip| and to test the installation +#. Ask Taweret team to trigger actions, confirm that this newest version is + being installed, and that all actions pass. Review Jupyter book rendering of + trees-based notebooks. Post-release actions -------------------- From 01a260b61fb047bad50f3116a0a7ab76aec5589c Mon Sep 17 00:00:00 2001 From: Jared O'Neal Date: Wed, 5 Aug 2026 11:11:36 -0500 Subject: [PATCH 2/2] (Issue #51) Cleaning as part of review. This should fix the broken action. --- docs/release_procedure.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/release_procedure.rst b/docs/release_procedure.rst index 0a0652d..74c27d7 100644 --- a/docs/release_procedure.rst +++ b/docs/release_procedure.rst @@ -104,10 +104,12 @@ When a particular commit on ``main`` is to be deemed a release, action's log. #. Carry out all necessary checks for the different software products (see below). - * TODO: If issues are found that require a new commit, the tag can be - reassigned to a new commit (extra effort to force update of tag in remote - and for other developers to move tag in their clones as well?). After - that, the release should be XYZ? + +.. todo:: + If issues are found that require a new commit, the tag can be reassigned to + a new commit (extra effort to force update of tag in remote and for other + developers to move tag in their clones as well?). After that, what needs to + be done to reissue the release at the updated tag? Command line tools ^^^^^^^^^^^^^^^^^^