[DOCS] Py Pkg Gen v2.0.2-dev Release

Release Version '2.0.02-dev into 'master' Branch

.github/workflows/merge-rt-in-release.yml

@@ -31,6 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      MAIN_BR: 'master'
       TRAIN: 'release-train'
       RELEASE_BR: 'release'
     steps:
@@ -43,7 +44,7 @@ jobs:
       - name: Ensure Release Branch exists, before PR
         run: |
           git branch --track "${{ env.RELEASE_BR }}" "origin/${{ env.RELEASE_BR }}" || echo "Branch '${{ env.RELEASE_BR }}' does NOT exist in remote Origin"
-          git checkout ${{ env.RELEASE_BR }} || (git checkout -b ${{ env.RELEASE_BR }} && git push origin -u ${{ env.RELEASE_BR }})
+          git checkout ${{ env.RELEASE_BR }} || (git checkout ${{ env.MAIN_BR }} && git checkout -b ${{ env.RELEASE_BR }} && git push origin -u ${{ env.RELEASE_BR }})
 
       ####### PR: Train --> Release #######
       - name: "Create PR  'head': ${{ env.TRAIN }}  -->  'base': ${{ env.RELEASE_BR }}"
@@ -87,3 +88,5 @@ jobs:
       ##### Auto Merge: Train --> Release #####
       - name: 'Merge PR   ${{ env.TRAIN }}  -->  ${{ env.RELEASE_BR }}'
         run: gh pr merge "${{ env.TRAIN }}" --auto --delete-branch --merge
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}  # allow event to trigger "listener" Workflows

.github/workflows/policy_lint.yml

@@ -188,6 +188,9 @@ jobs:
           config: |
             paths-ignore:
               - 'src/cookiecutter_python/{{ cookiecutter.project_slug }}/'
+              - 'src/cookiecutter_python/{{ cookiecutter.project_slug }}/**'
+              - 'src/cookiecutter_python/{{ cookiecutter.project_slug }}/**/*'
+              - 'src/cookiecutter_python/{{ cookiecutter.project_slug }}/*'
               - 'src/cookiecutter_python/{{ cookiecutter.project_slug }}/tests/test_cli.py'
 
             # disable-default-queries: true

.github/workflows/tag-prod.yml

@@ -49,6 +49,9 @@ jobs:
         run: echo "PROD_TAG=v${{ env.SEMVER }}" >> $GITHUB_ENV
 
       # Trigger CI/CD for 'Production Release'
+      - run: git config --global user.name "Konstantinos Lampridis"
+      - run: git config --global user.email "[email protected]"
+
       - name: "Push '${{ env.PROD_TAG }}' to trigger CI/CD for 'Production Release'"
         run: |
           git tag "${{ env.PROD_TAG }}" -m "Production Release ${{ env.PROD_TAG }}"

CHANGELOG.rst

@@ -2,6 +2,32 @@
 Changelog
 =========
 
+2.0.2-dev (2024-02-27)
+======================
+
+Changes
+^^^^^^^
+
+documentation
+"""""""""""""
+- improve clean-up instructions in Git Ops Cheatsheet Page
+
+ci
+""
+- add glob patterns to exclude Template Project contents from CodeQL
+
+release
+"""""""
+- bump version to 2.0.2-dev
+
+gitops
+""""""
+- support automatic Source Sem Ver update for '-rc' and '-dev' sem ver metadata
+- allow workflows to trigger on event 'merge to Release'
+- add user name and email before tagging prod tag on Main/Master
+- ensure release branch is on master, in 'RT in Release' Workflow
+
+
 2.0.1 (2024-02-25)
 ==================
 

README.rst

@@ -275,9 +275,9 @@ Free/Libre and Open Source Software (FLOSS)
 
 .. Github Releases & Tags
 
-.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.0.1/master?color=blue&logo=github
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.0.2-dev/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v2.0.1..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v2.0.2-dev..master
 
 .. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver
     :alt: GitHub commits since latest release (by SemVer)

docs/conf.py

@@ -30,7 +30,7 @@
 author = 'Konstantinos Lampridis'
 
 # The full version, including alpha/beta/rc tags
-release = '2.0.1'
+release = '2.0.2-dev'
 
 # -- General configuration ---------------------------------------------------
 

docs/contents/35_development/gitops-v2-cheatsheet.md

@@ -73,13 +73,28 @@ gh release create "$tt"
 ```
 **--> !! DONE !! <--**
 
-Clean Git with:
+Clean Origin Git with:
 
 ```shell
-git checkout release && git rebase master
-# Delete Git Ops Tags
+# Delete Git Ops TAGS
 git push origin -d board-request
 git push origin -d auto-prod
-# Delete Git Ops branches
-git push origin -d board-request
+
+# Delete Git Ops BRANCHES
+git push origin -d boarding-auto
+
+git push origin -d test-docs
+git push origin -d test-distro
+git push origin -d test-distro-docs
+git push origin -d direct-onboarding
+
+git push origin -d release-train
+
+```
+
+Clean Local with:
+```shell
+git tag -d board-request
+git tag -d auto-prod
 ```
+git checkout release && git rebase master

pyproject.toml

@@ -10,7 +10,7 @@ build-backend = "poetry.core.masonry.api"
 ## Also renders on pypi as 'subtitle'
 [tool.poetry]
 name = "cookiecutter_python"
-version = "2.0.1"
+version = "2.0.2-dev"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 authors = ["Konstantinos Lampridis <[email protected]>"]
 maintainers = ["Konstantinos Lampridis <[email protected]>"]

scripts/distro-sem-ver-bump.sh

@@ -1,22 +1,28 @@
 #!/usr/bin/env sh
 
 VERSION="${1}"
-GITHUB_ORG="${2:-boromir674}"
-REPO="${3:-cookiecutter-python}"
+# GITHUB_ORG="${2:-boromir674}"
+# REPO="${3:-cookiecutter-python}"
 
 
 # CONSTANTS
+# Sem Ver Major Minor Patch + Pre-release metadata
+regex="[0-9]+\.[0-9]+\.[0-9]+(?:\-[a-zA-Z0-9]+(?:\.[a-zA-Z0-9]+)*)?"
+
 VERSION_VAR='__version__'
 
+
 # DISTRO Sem Ver
 
 ## Python Poetry BUILD - Bound - Sem Ver
 PYPROJECT='pyproject.toml'
-sed -i.bak -E "s/(version = ['\"])[0-9]+\.[0-9]+\.[0-9]+(['\"])/\\1${VERSION}\\2/" "${PYPROJECT}" && rm "${PYPROJECT}.bak"
+# sed -i.bak -E "s/(version = ['\"])[0-9]+\.[0-9]+\.[0-9]+(['\"])/\\1${VERSION}\\2/" "${PYPROJECT}" && rm "${PYPROJECT}.bak"
+sed -i.bak -E "s/(version = ['\"])${regex}(['\"])/\\1${VERSION}\\2/" "${PYPROJECT}" && rm "${PYPROJECT}.bak"
 
 ## Project Specific - Bound - Sem Ver
 INIT_FILE='src/cookiecutter_python/__init__.py'
-sed -i.bak -E "s/(${VERSION_VAR} = ['\"])[0-9]+\.[0-9]+\.[0-9]+(['\"])/\\1${VERSION}\\2/" "${INIT_FILE}" && rm "${INIT_FILE}.bak"
+# sed -i.bak -E "s/(${VERSION_VAR} = ['\"])[0-9]+\.[0-9]+\.[0-9]+(['\"])/\\1${VERSION}\\2/" "${INIT_FILE}" && rm "${INIT_FILE}.bak"
+sed -i.bak -E "s/(${VERSION_VAR} = ['\"])${regex}(['\"])/\\1${VERSION}\\2/" "${INIT_FILE}" && rm "${INIT_FILE}.bak"
 
 ## Other Builds
 

src/cookiecutter_python/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '2.0.1'
+__version__ = '2.0.2-dev'
 
 from . import _logging  # noqa