From 8487904228f6ee9d68a39fc143f2be38d9d4a3ad Mon Sep 17 00:00:00 2001
From: mike7ant <16749494+mike7ant@users.noreply.github.com>
Date: Tue, 18 Mar 2025 21:11:04 -0700
Subject: [PATCH] core: added comments about PyPI actions

---
 .github/workflows/pypi.yml | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml
index 1940cb69..7a03d336 100644
--- a/.github/workflows/pypi.yml
+++ b/.github/workflows/pypi.yml
@@ -1,3 +1,6 @@
+# Triggered on any push that creates a tag, this workflow builds a source 
+# distribution package and uploads it to Python package index. This allows
+# users to 'pip install deeporigin'.
 name: Publish to PyPI
 
 on:
@@ -10,7 +13,7 @@ jobs:
     name: Build and upload release to PyPI
     runs-on: ubuntu-latest
     permissions:
-      id-token: write
+      id-token: write # pypi-publish might need OIDC token to authenticate with PyPI
     steps:
 
       - name: Checkout code
@@ -27,6 +30,8 @@ jobs:
 
       - name: Extract tag name
         id: tag
+        # GITHUB_REF contains full reference name, 'refs/tags/v1.0.0, so this 
+        # extracts just the tag name (v1.0.0)
         run: echo ::set-output name=TAG_NAME::$(echo $GITHUB_REF | cut -d / -f 3)
 
       - name: Update version number from tag