Skip to content

Commit 9ccdaff

Browse files
authored
refactor(ci): standardize workflows and unify copyright notices (#17)
## Description - **CI/CD Workflow Restructuring & Standardization**: - Redesigned and documented GitHub Action workflows (`pipeline-development.yml`, `pipeline-main.yml`, `pipeline-nightly.yml`, `pipeline-release.yml`, `pipeline-weekly.yml`, `util-cleanup.yml`, `util-pr-comment.yml`) with visual ASCII architecture maps outlining job dependencies. - Streamlined stage synchronization by introducing dedicated gate jobs (`build-gate` and `e2e-gate`) to coordinate build steps and test execution blocks. - Parameterized Python environments dynamically across matrix test runs using outputs from initialization gating (`init-gate.outputs.default_python`, `init-gate.outputs.full_matrix`), avoiding hardcoded values. - Added new development configurations including `.devcontainer/devcontainer.json` and `.github/pipeline-config.json`. - **Copyright & License Header Alignment**: - Ensured consistent presence of the Apache 2.0 license notice block in root files (e.g. `pyproject.toml`, `README.md`, `CONTRIBUTING.md`, `DEVELOPING.md`), `.github/` configurations, and `.devcontainer/` folder assets. - Standardized directory-level boundaries by adding/maintaining the copyright block on directory boundary files (`README.md`, `__init__.py`, `conftest.py`, `docs/index.md`) across primary directories (`tests/`, `src/`, `scripts/`, `examples/`, `docs/`). - Stripped redundant boilerplate notices from nested implementation files, utility scripts, and unit/integration tests to keep inner files clean and focused. ## Type of Change - [x] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] Documentation update (changes to `README.md`, `SUPPORT.md`, docstrings, etc.) - [x] Maintenance/Refactoring (non-breaking change that improves code structure or quality) ## Test Plan - **Automated Functional Verification**: - Ran the functional unit and integration test suite via Hatch to ensure that all core logic, plugins, and configurations remain healthy: ```bash .venv/bin/hatch run python:tests-func ``` - **Result:** `758 passed, 1 warning in 55.17s` ## Related Issues - Fixes #None ## Screenshots / Visuals (if applicable) N/A ## Use of AI - [x] Includes AI-assisted code completion - [x] Includes code generated by an AI application - [ ] Includes AI-generated tests ## Checklist > [!IMPORTANT] > Please review and complete this checklist before submitting your PR. This helps our maintainers process your contribution faster and ensures it meets the quality standards. - [x] "I certify that all code in this PR is my own, except as noted below." - [x] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guide. - [x] My code follows the established style guidelines. - [x] I have performed a self-review of my own code. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have made corresponding changes to the documentation. - [x] My changes generate no new warnings or errors. - [ ] I have added tests that prove my fix is effective or that my feature works. - [x] New and existing unit tests pass locally with my changes.
1 parent c6a752d commit 9ccdaff

80 files changed

Lines changed: 1227 additions & 860 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.detect-secrets.scan.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,5 +139,5 @@
139139
}
140140
]
141141
},
142-
"generated_at": "2026-05-29T03:01:36Z"
142+
"generated_at": "2026-05-29T15:37:29Z"
143143
}

.github/CODEOWNERS

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,17 @@
1-
# =============================================================================
2-
# CODEOWNERS — Automated Review Assignment
1+
# Copyright 2026 markurtz
32
#
4-
# GitHub uses this file to automatically request reviews from the designated
5-
# code owners when a pull request modifies files matching a given pattern.
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
66
#
7-
# HOW TO USE THIS FILE:
8-
# 1. Replace all placeholder GitHub usernames (e.g., @org/team-name or
9-
# @username) with your actual GitHub team or individual usernames.
10-
# 2. Rules are evaluated from top to bottom. The LAST matching rule wins.
11-
# 3. Patterns follow the same syntax as .gitignore.
7+
# http://www.apache.org/licenses/LICENSE-2.0
128
#
13-
# REFERENCE:
14-
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
15-
# =============================================================================
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
1614

17-
# -----------------------------------------------------------------------------
18-
# Default Owner
19-
# Catches all files not matched by a more specific rule below.
20-
# This team or user is the reviewer of last resort.
21-
# -----------------------------------------------------------------------------
2215
* @markurtz
2316

2417
# -----------------------------------------------------------------------------

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
11
---
2+
# Copyright 2026 markurtz
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
215
name: 🐛 Bug Report
316
description: Create a report to help us improve gitversioned
417
labels:

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
11
---
2+
# Copyright 2026 markurtz
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
215
name: Feature Request
316
description: Suggest an idea for gitversioned
417
labels:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
<!--
2+
Copyright 2026 markurtz
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
-->
16+
117
<!--
218
Thanks for contributing to GitVersioned!
319
Please review the [Contributing Guidelines](../CONTRIBUTING.md) before submitting your PR.

.github/actions/oci/build/action.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ description: "Builds container image and saves it as a tarball"
1717
inputs:
1818
python-version:
1919
description: "Python version to set up for tooling"
20-
required: false
21-
default: "3.10"
20+
required: true
2221
force-run:
2322
description: "Always run even if no changes are detected"
2423
required: false

.github/actions/oci/quality/action.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ description: "Runs Dockerfile and Docker Compose linters and security checks"
1717
inputs:
1818
python-version:
1919
description: "Python version to set up for tooling"
20-
required: false
21-
default: "3.10"
20+
required: true
2221
force-run:
2322
description: "Always run even if no changes are detected"
2423
required: false

.github/actions/oci/tests/action.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ description: "Runs OCI container structure tests (E2E) and no-op functional test
1717
inputs:
1818
python-version:
1919
description: "Python version to set up for tooling"
20-
required: false
21-
default: "3.10"
20+
required: true
2221
image-tar:
2322
description: "The path to a pre-built image tarball to load"
2423
required: true

.github/actions/project/docs/action.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ inputs:
2020
required: true
2121
python-version:
2222
description: "Python version to set up for tooling"
23-
required: false
24-
default: "3.10"
23+
required: true
2524
force-run:
2625
description: "Always run even if no changes are detected"
2726
required: false

.github/actions/project/quality/action.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ description: "Runs project linting, formatting, and security checks"
1717
inputs:
1818
python-version:
1919
description: "Python version to set up"
20-
required: false
21-
default: "3.10"
20+
required: true
2221
force-run:
2322
description: "Always run even if no changes are detected"
2423
required: false

0 commit comments

Comments
 (0)