Skip to content

Base setup for GitVersioned to migrate from python template#1

Merged
markurtz merged 3 commits into
mainfrom
feature/base-repo
May 1, 2026
Merged

Base setup for GitVersioned to migrate from python template#1
markurtz merged 3 commits into
mainfrom
feature/base-repo

Conversation

@markurtz
Copy link
Copy Markdown
Owner

@markurtz markurtz commented May 1, 2026

Description

This PR initializes the core repository structure and configuration for GitVersioned. It establishes the architectural baseline required to support opinionated Python versioning and auditability without introducing the functional implementation logic yet.

Key changes include:

  • Identity & Metadata: Configured pyproject.toml with project-specific metadata, dependencies (Hatch/Setuptools hooks), and PEP 440 compliance settings.
  • Structural Scaffolding: Created the src/gitversioned/ package layout and tests/ directory.
  • Compliance Baseline: Integrated Apache 2.0 LICENSE and NOTICE files tailored for GitVersioned.
  • Tooling Alignment: Refined ruff, mypy, and pytest configurations to enforce the "predictable and foolproof" nature of the project's future automation.

Type of Change

  • ✨ New feature (Initial project scaffolding/foundation)
  • 📝 Documentation update (Project-specific README and metadata)
  • 🛠️ Maintenance/Refactoring (Template-to-project specialization)

Test Plan

  • Static Analysis: Ran ruff check . and mypy src/ to ensure the empty package structure passes linting.
  • Installation Sandbox: Verified pip install -e . executes successfully in a clean virtual environment.
  • Schema Validation: Validated pyproject.toml against standard PEP 621/518 schemas.

Related Issues

Screenshots / Visuals (if applicable)

N/A - Initial structural commit.

Use of AI

  • Includes AI-assisted code completion (Standard boilerplate generation)

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.

  • "I certify that all code in this PR is my own, except as noted below."
  • I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guide.
  • My code follows the established style guidelines of gitversioned.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings or errors.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

@markurtz markurtz requested a review from Copilot May 1, 2026 19:55
@markurtz markurtz self-assigned this May 1, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

CI Development Pipeline Status

Pipeline: Failed or was cancelled. Check logs

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

CI Development Pipeline Status

Pipeline: Completed successfully. View Run Details

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR establishes the initial GitVersioned repository baseline by replacing template placeholders with project-specific metadata, wiring up Python packaging/tooling, and scaffolding documentation and developer workflows.

Changes:

  • Initialized Python package scaffolding under src/gitversioned/ (typed package, CLI entrypoint, version).
  • Specialized project configuration for build/test/lint/docs tooling (pyproject.toml, mkdocs.yml, Dependabot, Docker/Compose).
  • Rebranded and updated documentation/community files from template placeholders to GitVersioned content.

Reviewed changes

Copilot reviewed 40 out of 42 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
test_snippet.md Removed template/mdformat wrapper snippet content.
test_link.md Removed templated “View on GitHub” link.
test2.md Removed templated URL content.
test.md Removed templated “View on GitHub” button link.
src/project_name/.gitkeep Removed template source placeholder directory marker.
src/gitversioned/py.typed Declares the package as typed (PEP 561).
src/gitversioned/__main__.py Adds a minimal executable module entrypoint.
src/gitversioned/__init__.py Adds package init and __version__.
scripts/bootstrap.sh Deletes template bootstrap placeholder-replacement script.
scripts/README.md Updates scripts documentation to GitVersioned and removes template examples list.
pyproject.toml Sets project metadata, Hatch envs/scripts, and tool configs for GitVersioned.
mkdocs.yml Rebrands MkDocs site config and documentation navigation.
llms.txt Updates LLM index to GitVersioned links and descriptions.
llms-full.txt Updates concatenated docs bundle to GitVersioned content and links.
examples/README.md Rebrands examples documentation to GitVersioned.
docs/reference/index.md Updates reference landing page text to GitVersioned.
docs/index.md Updates docs homepage hero and links to GitVersioned.
docs/guides/index.md Updates guide index text to GitVersioned and trims template sections.
docs/getting-started/workflows.md Replaces template workflows with GitVersioned-oriented CLI workflows.
docs/getting-started/quickstart.md Updates quickstart install/usage text to GitVersioned CLI.
docs/getting-started/installation.md Updates install instructions, clone URLs, and Docker image references.
docs/getting-started/index.md Updates getting-started landing page to GitVersioned.
docs/examples/index.md Updates examples landing page to GitVersioned.
docs/community/index.md Updates community page links and references to GitVersioned.
docker-compose.yml Rebrands compose service command/module name and DB default.
SUPPORT.md Updates support channels and links to GitVersioned.
SECURITY.md Updates security policy content and reporting links for GitVersioned.
README.md Rebrands README, links, and project positioning for GitVersioned.
NOTICE Updates notice attribution to GitVersioned and maintainer.
Dockerfile Rebrands Docker build scaffolding to gitversioned.
DEVELOPING.md Updates developer setup instructions (Docker + Hatch workflow).
CONTRIBUTING.md Rebrands contributing guide and links to GitVersioned.
CODE_OF_CONDUCT.md Rebrands CoC and updates contact email.
CITATION.cff Rebrands citation metadata to GitVersioned.
AGENTS.md Updates agent/project context and removes template placeholder guidance.
.github/dependabot.yml Enables pip/docker updates and assigns reviewer/assignee.
.github/PULL_REQUEST_TEMPLATE.md Rebrands PR template references to GitVersioned.
.github/ISSUE_TEMPLATE/feature_request.yml Updates feature request template text and links.
.github/ISSUE_TEMPLATE/bug_report.yml Updates bug report template text, links, and version field label.
.github/CODEOWNERS Sets CODEOWNERS entries to @markurtz and rebrands rules.
.env.example Rebrands default app/db names to GitVersioned.
.editorconfig Rebrands EditorConfig header comment.
Comments suppressed due to low confidence (1)

DEVELOPING.md:30

  • The Docker quickstart implies docker-compose up -d --build will “spin up the development environment”, but docker-compose.yml currently runs python -m gitversioned which exits immediately. Either adjust the compose app command to a long-running dev process, or update this section to clarify it’s a one-shot container run rather than a persistent environment.
> [!IMPORTANT]
> The `Dockerfile` and `docker-compose.yml` files are provided for convenience.
>
> You can spin up the development environment with:
>
> ```bash
> git clone https://github.com/markurtz/git-versioned.git
> cd git-versioned
>
> # Build and start the development environment in the background
> docker-compose up -d --build
> ```

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread llms-full.txt Outdated
Comment thread llms-full.txt Outdated
Comment thread README.md
Comment thread docs/getting-started/quickstart.md
Comment thread docs/getting-started/workflows.md
Comment thread docs/getting-started/workflows.md
Comment thread CITATION.cff Outdated
Comment thread docs/getting-started/quickstart.md
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

CI Development Pipeline Status

Pipeline: Completed successfully. View Run Details

@markurtz markurtz merged commit cfd6a68 into main May 1, 2026
13 checks passed
@markurtz markurtz deleted the feature/base-repo branch May 1, 2026 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants