[NEW] Python Project Generator v2.6.2

Release v2.6.2

Author: boromir674

CHANGELOG.rst

@@ -3,6 +3,19 @@ Changelog
 =========
 
 
+2.6.2 (2025-05-17)
+==================
+
+Changes
+^^^^^^^
+
+chore
+"""""
+- sem ver bump to 2.6.2
+- add try/catch with 3 retries for 'auto merge'
+- improve terminal based release script
+
+
 2.6.1 (2025-05-16)
 ==================
 

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://img.shields.io/github/actions/workflow/status/boromir674/cookiecutter-python-package/test.yaml?link=https%3A%2F%2Fgithub.com%2Fboromir674%2Fcookiecutter-python-package%2Factions%2Fworkflows%2Ftest.yaml%3Fquery%3Dbranch%253Amaster)](https://github.com/boromir674/cookiecutter-python-package/actions/workflows/test.yaml?query=branch%3Amaster) [![Coverage](https://img.shields.io/codecov/c/github/boromir674/cookiecutter-python-package/master?logo=codecov)](https://app.codecov.io/gh/boromir674/cookiecutter-python-package) [![Docs](https://img.shields.io/readthedocs/python-package-generator/master?logo=readthedocs&logoColor=lightblue)](https://python-package-generator.readthedocs.io/en/master/) [![Maintainability](https://api.codeclimate.com/v1/badges/1d347d7dfaa134fd944e/maintainability)](https://codeclimate.com/github/boromir674/cookiecutter-python-package/maintainability)
 [![Release Version](https://img.shields.io/pypi/v/cookiecutter_python)](https://pypi.org/project/cookiecutter-python/) [![Wheel](https://img.shields.io/pypi/wheel/cookiecutter-python?color=green&label=wheel)](https://pypi.org/project/cookiecutter-python) [![Tech Debt](https://img.shields.io/codeclimate/tech-debt/boromir674/cookiecutter-python-package)](https://codeclimate.com/github/boromir674/cookiecutter-python-package/) [![Codacy](https://app.codacy.com/project/badge/Grade/5be4a55ff1d34b98b491dc05e030f2d7)](https://app.codacy.com/gh/boromir674/cookiecutter-python-package/dashboard?utm_source=github.com&utm_medium=referral&utm_content=boromir674/cookiecutter-python-package&utm_campaign=Badge_Grade)
 [![Supported Versions](https://img.shields.io/pypi/pyversions/cookiecutter-python?color=blue&label=python&logo=python&logoColor=%23ccccff)](https://pypi.org/project/cookiecutter-python)
-[![PyPI Stats](https://img.shields.io/pypi/dm/cookiecutter-python?logo=pypi&logoColor=%23849ED9&color=%23849ED9)](https://pypistats.org/packages/cookiecutter-python) [![Commits Since Tag](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.6.1/master?color=blue&logo=github)](https://github.com/boromir674/cookiecutter-python-package/compare/v2.6.1..master) [![Commits Since Release](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver)](https://github.com/boromir674/cookiecutter-python-package/releases)
+[![PyPI Stats](https://img.shields.io/pypi/dm/cookiecutter-python?logo=pypi&logoColor=%23849ED9&color=%23849ED9)](https://pypistats.org/packages/cookiecutter-python) [![Commits Since Tag](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.6.2/master?color=blue&logo=github)](https://github.com/boromir674/cookiecutter-python-package/compare/v2.6.2..master) [![Commits Since Release](https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver)](https://github.com/boromir674/cookiecutter-python-package/releases)
 [![License](https://img.shields.io/github/license/boromir674/cookiecutter-python-package)](https://github.com/boromir674/cookiecutter-python-package/blob/master/LICENSE) [![OpenSSF](https://bestpractices.coreinfrastructure.org/projects/5988/badge)](https://bestpractices.coreinfrastructure.org/en/projects/5988) [![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://docs.astral.sh/ruff/) [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 

pyproject.toml

@@ -14,7 +14,7 @@ build-backend = "poetry.core.masonry.api"
 name = "cookiecutter_python"
 ### ... ###
 
-version = "2.6.1"
+version = "2.6.2"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 readme = "README.md"
 license = "AGPL-3.0-only"
@@ -74,7 +74,7 @@ maintainers = [
 license = {text = "AGPL-3.0-only"}
 
 name = "cookiecutter_python"
-version = "2.6.1"
+version = "2.6.2"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 readme = "README.md"
 # keywords = []

scripts/terminal-based-release.sh

@@ -1,6 +1,20 @@
 #!/usr/bin/env bash
 
-# RUN THIS, WHEN All changes for Release are on the dev branch
+### Part of Release Process ###
+
+# Topic_A, Topic_B, ... , Topic_N
+#    \         |            /
+#     \        |           /
+#       \      |         /
+#         \    |       /
+#         Integration_Br
+#              |
+#          Release_Br
+#              |
+#          Default_Br
+
+# RUN THIS, WHEN All changes for Release are ALREADY on the Integration_Br branch
+
 
 ## CONFIGURATION
 ### 1. SEM VER SOURCE UPDATE ###
@@ -21,7 +35,8 @@ DEFAULT_BRANCH=${_MAIN}
 
 # INPUTS
 # 1. NEW_VERSION: The new version to be released
-# 2. DEV (Optional): The branch where all changes merge too, initially
+# 2. Branch with Changes DEV (Optional): The branch where all changes for release are, initially
+# 3. Branch 
 
 # USAGE
 # ./terminal-based-release.sh <NEW_VERSION> [<DEV>]
@@ -93,8 +108,7 @@ echo =======
 # Press any key to continue dialog .. (unless ctrl + C)
 read -ep "Press any key to commit!" -n1 -s
 
-# read -tn $'Press any key to continue dialog .. (unless ctrl + C)\n'
-
+### 1.a Commit the changes
 git commit -m "chore: sem ver bump to ${NEW_VERSION}"
 
 
@@ -124,6 +138,7 @@ echo =======
 # Dialog before Commit
 read -ep "Press any key to commit '${CHANGELOG_FILE}' !" -n1 -s
 
+### 2.a Commit the changes
 git commit -m "docs: add ${NEW_VERSION} Release entry in ${CHANGELOG_FILE}"
 
 echo
@@ -132,35 +147,59 @@ echo "DONE !"
 echo
 read -ep "Press any key to push changes to ${BRANCH_WITH_CHANGES} remote!" -n1 -s
 
+## PUSH Integration_Br (dev) TO REMOTE
 git push
 
 git checkout ${RELEASE_BR}
 git rebase ${DEFAULT_BRANCH}
 git push
 
 git checkout "${BRANCH_WITH_CHANGES}"
+
+## OPEN PR TO RELEASE BRANCH
 gh pr create --base ${RELEASE_BR} --head "${BRANCH_WITH_CHANGES}" --title "Release v${NEW_VERSION}"
 
-gh pr merge ${BRANCH_WITH_CHANGES} --merge --auto
 
+## ENABLE AUTO MERGE with 'merge' strategy (others are 'squash' and 'rebase')
+# this cmd 'gh pr merge ${BRANCH_WITH_CHANGES} --merge --auto' randomly exits with error code 1.
+# need to "catch" and retry untill success (max retried = 3)
+
+set +e
+gh pr merge "${BRANCH_WITH_CHANGES}" --merge --auto
+if [ $? -ne 0 ]; then
+    echo "gh pr merge ${BRANCH_WITH_CHANGES} --merge --auto failed, retrying..."
+    for i in {1..3}; do
+        gh pr merge "${BRANCH_WITH_CHANGES}" --merge --auto
+        if [ $? -eq 0 ]; then
+            break
+        fi
+    done
+fi
+set -e
+
+
+## WATCH GITHUB ACTIONS WORKFLOWS RUNNING
+echo "========== Watch GH Workflow Run =========="
 gh run watch
 
 echo "========================="
 echo "DONE! PR ${BRANCH_WITH_CHANGES} --> ${RELEASE_BR} Merged !"
 
-# Update Local Release Branch
 git checkout ${RELEASE_BR}
 
 echo
 read -ep "Press any key to update local '${RELEASE_BR}' branch from remote!" -n1 -s
 
+## PULL RELEASE BRANCH
 git pull
 
+## CREATE PR TO DEFAULT_BRANCH (ie release --> main)
 gh pr create --base ${DEFAULT_BRANCH} --head "${RELEASE_BR}" --title "Release v${NEW_VERSION}"
 echo
 read -ep "Press any key to make a RELEASE CANDIDATE '${RELEASE_BR}' branch from remote!" -n1 -s
 
-RC_TAG="v${RELEASE_BR}-rc"
+## CREATE and PUSH RC TAG
+RC_TAG="v${NEW_VERSION}-rc"
 
 git tag -f "$RC_TAG"
 git push origin -f "$RC_TAG"
@@ -176,6 +215,7 @@ read -ep "Please run 'gh run watch' to watch the CI/CD Pipeline (press any key t
 # read -ep "Please watch the CI/CD Pipeline to succeed (press any key to continue to 'live watch') !" -n1 -s
 # gh run watch
 
+## PROMPT USER TO MERGE the PR if QA/CHECKS PASSED
 echo "========================="
 echo "Assuming CI/CD Pipeline Succeeded !"
 

src/cookiecutter_python/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '2.6.1'
+__version__ = '2.6.2'
 
 from . import _logging  # noqa