Add atomic PR ID job - Python tool POC

[joseph-flinn]

🎟️ Tracking

Testing idea of atomic and testable workflow jobs

🚧 Type of change

• 🚀 New feature development
• 🤖 Build/deploy pipeline (DevOps)

📔 Objective

Add an atomic job to pull the PR ID that is associated with a commit SHA built in Python with a full suite for testing (POC;: should be thrown out if we want to adopt something like this).

📋 Code changes

• .github/jobs-py: new directory with script and supporting tests for those job scripts
• .github/workflows/test_jobs_py.yml: CI pipeline to test changes to the python automation jobs

📸 Screenshots

⏰ Reminders before review

• Contributor guidelines followed
• All formatters and local linters executed and passed
• Written new unit and / or integration tests where applicable
• Used internationalization (i18n) for all UI strings
• CI builds passed
• Communicated to DevOps any deployment requirements
• Updated any necessary documentation or informed the documentation team

🦮 Reviewer guidelines

• 👍 (:+1:) or similar for great changes
• 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
• ❓ (:question:) for questions
• 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
• 🎨 (:art:) for suggestions / improvements
• ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
• 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
• ⛏ (:pick:) for minor or nitpick changes

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[Copilot]

Copilot reviewed 12 out of 15 changed files in this pull request and generated 1 comment.

Files not reviewed (3)

• .github/jobs-py/.env.example: Language not supported
• .github/jobs-py/.gitignore: Language not supported
• .github/jobs-py/shell.nix: Language not supported

Comments suppressed due to low confidence (2)

.github/jobs-py/src/get_pr_id.py:20

• [nitpick] The regex pattern assumes that commit messages contain exactly one PR reference in the format '(#)'. This approach can be brittle if the format changes or if multiple instances appear; consider improving the pattern's robustness or handling multiple matches explicitly.

result = re.search(r"(\(#\d+\))", message)

.github/jobs-py/src/get_pr_id.py:26

• [nitpick] There is no test case that simulates a GithubException being raised (e.g., due to an invalid commit SHA or authentication failure). Adding a unit test for this exception path would improve test coverage.

except GithubException:

[Copilot]

Using an empty string as the default for GITHUB_TOKEN may result in silent authentication failures. Consider checking whether GITHUB_TOKEN is provided and raising an error if it's missing to avoid ambiguous failures later.