Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/_build_container.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# ─────────────────────────────────────────────────────────────────────────────
# _build_container.yml — Reusable Container Builder
# _build_container.yml
#
# Builds container images for the project. This workflow handles only the
# build step. It returns the image name and tag, allowing calling workflows
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/_build_package.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# ─────────────────────────────────────────────────────────────────────────────
# _build_package.yml — Reusable Package Builder
# _build_package.yml
#
# Compiles or packages the project. This workflow handles only the build step.
# It returns the directory where the build artifacts are located, allowing
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/_docs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# ─────────────────────────────────────────────────────────────────────────────
# _docs.yml — Reusable Documentation Builder & Deployer
# _docs.yml
#
# Builds static documentation using MkDocs and Mike for versioning, and
# deploys it to GitHub Pages.
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/_link-check.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# ─────────────────────────────────────────────────────────────────────────────
# _link-check.yml — Reusable Documentation Link Checker
# _link-check.yml
#
# Validates that all hyperlinks in project documentation and Markdown files
# are reachable and not returning errors.
Expand Down Expand Up @@ -41,8 +41,8 @@ jobs:
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2
id: lychee
with:
args: --verbose --no-progress --accept 200,206,301,302,429 --exclude-loopback --exclude-mail
--exclude "\{\{[^}]+\}\}" '**/*.md'
args: --verbose --no-progress --accept 200,206,301,302,429 --exclude-loopback --exclude
"\{\{[^}]+\}\}" '**/*.md'
Comment thread
markurtz marked this conversation as resolved.
fail: ${{ inputs.fail_on_error }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/_pr_comment.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# =============================================================================
# pr_comment.yml — Safe PR Commenting
# pr_comment.yml
#
# Triggers:
# workflow_run → CI — Development (completed)
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/_quality.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# ─────────────────────────────────────────────────────────────────────────────
# _quality.yml — Reusable Quality Gate
# _quality.yml
#
# Encapsulates quality checking, style/lint, and type checking.
# Fails the pipeline if any of these checks fail.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/_security.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# ─────────────────────────────────────────────────────────────────────────────
# _security.yml — Reusable Security Audit
# _security.yml
#
# Performs dependency vulnerability scanning and secret scanning.
#
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/_tests.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# ─────────────────────────────────────────────────────────────────────────────
# _tests.yml — Reusable Test Runner
# _tests.yml
#
# Executes the project test suite using specified types and levels.
#
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/branding/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="docs/assets/branding/logo-light.svg">
<img alt="GitVersioned Logo" src="docs/assets/branding/logo-light.svg" width="400">
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/markurtz/git-versioned/main/docs/assets/branding/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/markurtz/git-versioned/main/docs/assets/branding/logo-light.svg">
<img alt="GitVersioned Logo" src="https://raw.githubusercontent.com/markurtz/git-versioned/main/docs/assets/branding/logo-light.svg" width="400">
</picture>
</p>

Expand Down Expand Up @@ -50,9 +50,9 @@ ______________________________________________________________________

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

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

## Advanced Usage

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

## General

### Contributing

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

### Support and Security

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

### AI & LLM Tooling

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

- **[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.
- **[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.
- **[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.
- **[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.

### License

This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
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.

### Citations

Expand Down
71 changes: 43 additions & 28 deletions docs/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,56 +4,71 @@

## Get Involved

<div class="grid cards" markdown>
<div class="grid" markdown>

- :material-source-pull: **Contributing**
<div class="card" markdown>
:material-source-pull: **Contributing**

______________________________________________________________________
______________________________________________________________________

How to report bugs, suggest features, and submit pull requests.
How to report bugs, suggest features, and submit pull requests.

[:octicons-arrow-right-24: Contributing Guide](contributing.md)
[:octicons-arrow-right-24: Contributing Guide](contributing.md)

- :material-wrench-outline: **Developer Setup**
</div>

<div class="card" markdown>
:material-wrench-outline: **Developer Setup**

______________________________________________________________________

Full environment setup guide for contributors — Docker, local dev,
testing, and code quality standards.

[:octicons-arrow-right-24: Developer Setup](developing.md)

______________________________________________________________________
</div>

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

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

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

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

Our community standards and the guidelines we expect all participants to follow.
</div>

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

- :material-shield-lock-outline: **Security Policy**
______________________________________________________________________

______________________________________________________________________
How to responsibly disclose security vulnerabilities and our triage process.

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

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

- :material-lifebuoy: **Support**
<div class="card" markdown>
:material-lifebuoy: **Support**

______________________________________________________________________
______________________________________________________________________

Where to ask questions, report issues, and find help.
Where to ask questions, report issues, and find help.

[:octicons-arrow-right-24: Support](support.md)
[:octicons-arrow-right-24: Support](support.md)

</div>

</div>

## Community Channels

| Channel | Purpose |
| :---------------------------------------------------------------------------- | :--------------------------------------------- |
| \[GitHub Issues\](https://github.com/markurtz/git-versioned/issues) | Bug reports and feature requests |
| \[GitHub Discussions\](https://github.com/markurtz/git-versioned/discussions) | Q&A, ideas, and general community conversation |
| \[Slack\](https://slack.markurtz.org) | Real-time chat with the team and community |
| \[Blog\](https://blog.markurtz.org) | Project updates, tutorials, and announcements |
| Channel | Purpose |
| :-------------------------------------------------------------------------- | :--------------------------------------------- |
| [GitHub Issues](https://github.com/markurtz/git-versioned/issues) | Bug reports and feature requests |
| [GitHub Discussions](https://github.com/markurtz/git-versioned/discussions) | Q&A, ideas, and general community conversation |
| [Slack](https://slack.markurtz.org) | Real-time chat with the team and community |
| [Blog](https://blog.markurtz.org) | Project updates, tutorials, and announcements |
50 changes: 28 additions & 22 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,42 @@ This section contains runnable code examples that demonstrate real-world usage o

## Example Categories

<div class="grid cards" markdown>
<div class="grid" markdown>

- :material-rocket-launch-outline: **Setuptools Examples**
<div class="card" markdown>
:material-rocket-launch-outline: **Setuptools Examples**

______________________________________________________________________
______________________________________________________________________

Simple, self-contained examples that demonstrate configuring `gitversioned` for projects using `setuptools`.
Simple, self-contained examples that demonstrate configuring `gitversioned` for projects using `setuptools`.

- [:octicons-arrow-right-24: Setuptools Configuration via Version File](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-file/)
- [:octicons-arrow-right-24: Setuptools Configuration via Version Function](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-function/)
- [:octicons-arrow-right-24: Setuptools Configuration via Tool Table](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-tool-table/)
- [:octicons-arrow-right-24: Setuptools Configuration via Git Tags](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-tags/)
- [:octicons-arrow-right-24: Setuptools Configuration via Git Branch](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-branch/)
- [:octicons-arrow-right-24: Setuptools Configuration via Git Commits](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-commits/)
- [:octicons-arrow-right-24: Setuptools Configuration via `setup.py`](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-setup-py/)
- [:octicons-arrow-right-24: Setuptools Configuration via `setup.cfg`](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-setup-cfg/)
- [:octicons-arrow-right-24: Setuptools Configuration via Version File](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-file/)
- [:octicons-arrow-right-24: Setuptools Configuration via Version Function](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-function/)
- [:octicons-arrow-right-24: Setuptools Configuration via Tool Table](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-tool-table/)
- [:octicons-arrow-right-24: Setuptools Configuration via Git Tags](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-tags/)
- [:octicons-arrow-right-24: Setuptools Configuration via Git Branch](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-branch/)
- [:octicons-arrow-right-24: Setuptools Configuration via Git Commits](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-version-commits/)
- [:octicons-arrow-right-24: Setuptools Configuration via `setup.py`](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-setup-py/)
- [:octicons-arrow-right-24: Setuptools Configuration via `setup.cfg`](https://github.com/markurtz/git-versioned/tree/main/examples/setuptools-setup-cfg/)

- :material-tune-variant: **Hatchling Examples**
</div>

<div class="card" markdown>
:material-tune-variant: **Hatchling Examples**

______________________________________________________________________
______________________________________________________________________

Simple, self-contained examples that demonstrate configuring `gitversioned` for projects using `hatchling`.
Simple, self-contained examples that demonstrate configuring `gitversioned` for projects using `hatchling`.

- [:octicons-arrow-right-24: Hatchling Configuration via Version File](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-file/)
- [:octicons-arrow-right-24: Hatchling Configuration via Version Function](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-function/)
- [:octicons-arrow-right-24: Hatchling Configuration via Hatch Vars](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-hatch-vars/)
- [:octicons-arrow-right-24: Hatchling Configuration via Tool Table](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-tool-table/)
- [:octicons-arrow-right-24: Hatchling Configuration via Git Tags](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-tags/)
- [:octicons-arrow-right-24: Hatchling Configuration via Git Branch](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-branch/)
- [:octicons-arrow-right-24: Hatchling Configuration via Git Commits](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-commits/)
- [:octicons-arrow-right-24: Hatchling Configuration via Version File](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-file/)
- [:octicons-arrow-right-24: Hatchling Configuration via Version Function](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-function/)
- [:octicons-arrow-right-24: Hatchling Configuration via Hatch Vars](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-hatch-vars/)
- [:octicons-arrow-right-24: Hatchling Configuration via Tool Table](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-tool-table/)
- [:octicons-arrow-right-24: Hatchling Configuration via Git Tags](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-tags/)
- [:octicons-arrow-right-24: Hatchling Configuration via Git Branch](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-branch/)
- [:octicons-arrow-right-24: Hatchling Configuration via Git Commits](https://github.com/markurtz/git-versioned/tree/main/examples/hatchling-version-commits/)

</div>

</div>

Expand Down
Loading
Loading