Skip to content

Commit 1fc1762

Browse files
markurtzmarkurtz
authored
chore(release): fix 0.1.0 infrastructure, tooling, and documentation updates
## Description This PR finalizes the repository infrastructure and documentation in preparation for the `0.1.0` release. Key changes include: - **Documentation Modernization:** Replaced broken HTML `div` wrappers with native MkDocs Material Attribute Lists (`{ .grid .cards }`) for cleaner grid layouts. Converted relative links in `README.md` to absolute URLs to ensure correct rendering on external platforms like PyPI. Restructured the `docs/` hierarchy, moving configuration content to `guides/`, and introduced a new GitHub CI/CD workflows guide. - **CI/CD & Tooling Fixes:** Resolved the `pre-commit: not found` CI error, fixed invalid arguments in the `lychee` link checker workflow, and updated core dependencies in `pyproject.toml` (including the addition of an OpenTelemetry dependency group). - **Core Infrastructure Improvements:** Refined `src/gitversioned/logging.py` to correctly format `__main__` entry points without requiring custom logger patches, and added supporting unit tests. ## Type of Change - [x] 🐛 Bug fix (non-breaking change which fixes an issue) - [ ] ✨ 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 - Verified automated CI checks (linting, pytest, lychee link check) pass successfully. - Locally generated and previewed the MkDocs site (`hatch run docs:serve`) to confirm grid card layouts and new guide pages render correctly. - Validated `__main__` logging output via the updated unit tests (`test_logging.py`). ## Related Issues - Fixes # (Note: Add relevant issue numbers here if applicable) ## Screenshots / Visuals (if applicable) *(No visual changes applicable for the core logic, though MkDocs layout adjustments can be observed in the generated site)* ## Use of AI - [x] Includes AI-assisted code completion - [x] Includes code generated by an AI application - [x] Includes AI-generated tests (NOTE: AI written tests should have a docstring that includes `## WRITTEN BY AI ##`) ## 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 of `gitversioned`. - [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 of `gitversioned`. - [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. - [x] 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 a6409ac commit 1fc1762

22 files changed

Lines changed: 702 additions & 567 deletions

File tree

‎.github/workflows/_build_container.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# ─────────────────────────────────────────────────────────────────────────────
3-
# _build_container.yml — Reusable Container Builder
3+
# _build_container.yml
44
#
55
# Builds container images for the project. This workflow handles only the
66
# build step. It returns the image name and tag, allowing calling workflows

‎.github/workflows/_build_package.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# ─────────────────────────────────────────────────────────────────────────────
3-
# _build_package.yml — Reusable Package Builder
3+
# _build_package.yml
44
#
55
# Compiles or packages the project. This workflow handles only the build step.
66
# It returns the directory where the build artifacts are located, allowing

‎.github/workflows/_docs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# ─────────────────────────────────────────────────────────────────────────────
3-
# _docs.yml — Reusable Documentation Builder & Deployer
3+
# _docs.yml
44
#
55
# Builds static documentation using MkDocs and Mike for versioning, and
66
# deploys it to GitHub Pages.

‎.github/workflows/_link-check.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# ─────────────────────────────────────────────────────────────────────────────
3-
# _link-check.yml — Reusable Documentation Link Checker
3+
# _link-check.yml
44
#
55
# Validates that all hyperlinks in project documentation and Markdown files
66
# are reachable and not returning errors.
@@ -41,8 +41,8 @@ jobs:
4141
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2
4242
id: lychee
4343
with:
44-
args: --verbose --no-progress --accept 200,206,301,302,429 --exclude-loopback --exclude-mail
45-
--exclude "\{\{[^}]+\}\}" '**/*.md'
44+
args: --verbose --no-progress --accept 200,206,301,302,429 --exclude-loopback --exclude
45+
"\{\{[^}]+\}\}" '**/*.md'
4646
fail: ${{ inputs.fail_on_error }}
4747
env:
4848
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/_pr_comment.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# =============================================================================
3-
# pr_comment.yml — Safe PR Commenting
3+
# pr_comment.yml
44
#
55
# Triggers:
66
# workflow_run → CI — Development (completed)

‎.github/workflows/_quality.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# ─────────────────────────────────────────────────────────────────────────────
3-
# _quality.yml — Reusable Quality Gate
3+
# _quality.yml
44
#
55
# Encapsulates quality checking, style/lint, and type checking.
66
# Fails the pipeline if any of these checks fail.

‎.github/workflows/_security.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# ─────────────────────────────────────────────────────────────────────────────
3-
# _security.yml — Reusable Security Audit
3+
# _security.yml
44
#
55
# Performs dependency vulnerability scanning and secret scanning.
66
#

‎.github/workflows/_tests.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# ─────────────────────────────────────────────────────────────────────────────
3-
# _tests.yml — Reusable Test Runner
3+
# _tests.yml
44
#
55
# Executes the project test suite using specified types and levels.
66
#

‎README.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<p align="center">
22
<picture>
3-
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/branding/logo-dark.svg">
4-
<source media="(prefers-color-scheme: light)" srcset="docs/assets/branding/logo-light.svg">
5-
<img alt="GitVersioned Logo" src="docs/assets/branding/logo-light.svg" width="400">
3+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/markurtz/git-versioned/main/docs/assets/branding/logo-dark.svg">
4+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/markurtz/git-versioned/main/docs/assets/branding/logo-light.svg">
5+
<img alt="GitVersioned Logo" src="https://raw.githubusercontent.com/markurtz/git-versioned/main/docs/assets/branding/logo-light.svg" width="400">
66
</picture>
77
</p>
88

@@ -50,9 +50,9 @@ ______________________________________________________________________
5050

5151
<p align="center">
5252
<picture>
53-
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/branding/user-flow-dark.svg">
54-
<source media="(prefers-color-scheme: light)" srcset="docs/assets/branding/user-flow-light.svg">
55-
<img alt="User Flow Diagram" src="docs/assets/branding/user-flow-light.svg" width="800">
53+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/markurtz/git-versioned/main/docs/assets/branding/user-flow-dark.svg">
54+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/markurtz/git-versioned/main/docs/assets/branding/user-flow-light.svg">
55+
<img alt="User Flow Diagram" src="https://raw.githubusercontent.com/markurtz/git-versioned/main/docs/assets/branding/user-flow-light.svg" width="800">
5656
</picture>
5757
</p>
5858

@@ -131,30 +131,30 @@ The repository is structured to separate documentation, application logic, and t
131131

132132
## Advanced Usage
133133

134-
Please check the [`examples/`](examples/) directory for advanced examples and configurations.
134+
Please check the [`examples/`](https://github.com/markurtz/git-versioned/tree/main/examples/) directory for advanced examples and configurations.
135135

136136
## General
137137

138138
### Contributing
139139

140-
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details. For development setup, check out [DEVELOPING.md](DEVELOPING.md).
141-
Please ensure you follow our [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions.
140+
We welcome contributions! Please see our [Contributing Guide](https://github.com/markurtz/git-versioned/blob/main/CONTRIBUTING.md) for more details. For development setup, check out [DEVELOPING.md](https://github.com/markurtz/git-versioned/blob/main/DEVELOPING.md).
141+
Please ensure you follow our [Code of Conduct](https://github.com/markurtz/git-versioned/blob/main/CODE_OF_CONDUCT.md) in all interactions.
142142

143143
### Support and Security
144144

145-
- For help and general questions, see [SUPPORT.md](SUPPORT.md).
146-
- To report a security vulnerability, please refer to our [Security Policy](SECURITY.md).
145+
- For help and general questions, see [SUPPORT.md](https://github.com/markurtz/git-versioned/blob/main/SUPPORT.md).
146+
- To report a security vulnerability, please refer to our [Security Policy](https://github.com/markurtz/git-versioned/blob/main/SECURITY.md).
147147

148148
### AI & LLM Tooling
149149

150150
This repository includes first-class support for agentic and LLM-assisted development workflows:
151151

152-
- **[AGENTS.md](AGENTS.md):** Repository-specific instructions for AI coding agents (Codex, Copilot Workspace, Gemini, Claude, Cursor, and similar tools). Contains the authoritative guide for project structure, executable commands, code style, and critical constraints.
153-
- **[llms.txt](llms.txt):** A machine-readable index of the project's documentation, following the [llms.txt specification](https://llmstxt.org/). Served at `/llms.txt` on the documentation site to help LLMs quickly locate and consume relevant content.
152+
- **[AGENTS.md](https://github.com/markurtz/git-versioned/blob/main/AGENTS.md):** Repository-specific instructions for AI coding agents (Codex, Copilot Workspace, Gemini, Claude, Cursor, and similar tools). Contains the authoritative guide for project structure, executable commands, code style, and critical constraints.
153+
- **[llms.txt](https://github.com/markurtz/git-versioned/blob/main/llms.txt):** A machine-readable index of the project's documentation, following the [llms.txt specification](https://llmstxt.org/). Served at `/llms.txt` on the documentation site to help LLMs quickly locate and consume relevant content.
154154

155155
### License
156156

157-
This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
157+
This project is licensed under the Apache License 2.0. See the [LICENSE](https://github.com/markurtz/git-versioned/blob/main/LICENSE) file for details.
158158

159159
### Citations
160160

‎docs/community/index.md‎

Lines changed: 43 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,56 +4,71 @@
44

55
## Get Involved
66

7-
<div class="grid cards" markdown>
7+
<div class="grid" markdown>
88

9-
- :material-source-pull: **Contributing**
9+
<div class="card" markdown>
10+
:material-source-pull: **Contributing**
1011

11-
______________________________________________________________________
12+
______________________________________________________________________
1213

13-
How to report bugs, suggest features, and submit pull requests.
14+
How to report bugs, suggest features, and submit pull requests.
1415

15-
[:octicons-arrow-right-24: Contributing Guide](contributing.md)
16+
[:octicons-arrow-right-24: Contributing Guide](contributing.md)
1617

17-
- :material-wrench-outline: **Developer Setup**
18+
</div>
19+
20+
<div class="card" markdown>
21+
:material-wrench-outline: **Developer Setup**
22+
23+
______________________________________________________________________
24+
25+
Full environment setup guide for contributors — Docker, local dev,
26+
testing, and code quality standards.
27+
28+
[:octicons-arrow-right-24: Developer Setup](developing.md)
1829

19-
______________________________________________________________________
30+
</div>
2031

21-
Full environment setup guide for contributors — Docker, local dev,
22-
testing, and code quality standards.
32+
<div class="card" markdown>
33+
:material-handshake-outline: **Code of Conduct**
2334

24-
[:octicons-arrow-right-24: Developer Setup](developing.md)
35+
______________________________________________________________________
2536

26-
- :material-handshake-outline: **Code of Conduct**
37+
Our community standards and the guidelines we expect all participants to follow.
2738

28-
______________________________________________________________________
39+
[:octicons-arrow-right-24: Code of Conduct](code-of-conduct.md)
2940

30-
Our community standards and the guidelines we expect all participants to follow.
41+
</div>
3142

32-
[:octicons-arrow-right-24: Code of Conduct](code-of-conduct.md)
43+
<div class="card" markdown>
44+
:material-shield-lock-outline: **Security Policy**
3345

34-
- :material-shield-lock-outline: **Security Policy**
46+
______________________________________________________________________
3547

36-
______________________________________________________________________
48+
How to responsibly disclose security vulnerabilities and our triage process.
3749

38-
How to responsibly disclose security vulnerabilities and our triage process.
50+
[:octicons-arrow-right-24: Security Policy](security.md)
3951

40-
[:octicons-arrow-right-24: Security Policy](security.md)
52+
</div>
4153

42-
- :material-lifebuoy: **Support**
54+
<div class="card" markdown>
55+
:material-lifebuoy: **Support**
4356

44-
______________________________________________________________________
57+
______________________________________________________________________
4558

46-
Where to ask questions, report issues, and find help.
59+
Where to ask questions, report issues, and find help.
4760

48-
[:octicons-arrow-right-24: Support](support.md)
61+
[:octicons-arrow-right-24: Support](support.md)
62+
63+
</div>
4964

5065
</div>
5166

5267
## Community Channels
5368

54-
| Channel | Purpose |
55-
| :---------------------------------------------------------------------------- | :--------------------------------------------- |
56-
| \[GitHub Issues\](https://github.com/markurtz/git-versioned/issues) | Bug reports and feature requests |
57-
| \[GitHub Discussions\](https://github.com/markurtz/git-versioned/discussions) | Q&A, ideas, and general community conversation |
58-
| \[Slack\](https://slack.markurtz.org) | Real-time chat with the team and community |
59-
| \[Blog\](https://blog.markurtz.org) | Project updates, tutorials, and announcements |
69+
| Channel | Purpose |
70+
| :-------------------------------------------------------------------------- | :--------------------------------------------- |
71+
| [GitHub Issues](https://github.com/markurtz/git-versioned/issues) | Bug reports and feature requests |
72+
| [GitHub Discussions](https://github.com/markurtz/git-versioned/discussions) | Q&A, ideas, and general community conversation |
73+
| [Slack](https://slack.markurtz.org) | Real-time chat with the team and community |
74+
| [Blog](https://blog.markurtz.org) | Project updates, tutorials, and announcements |

0 commit comments

Comments
 (0)