Base setup for GitVersioned to migrate from python template#1
Merged
Conversation
Contributor
CI Development Pipeline Status❌ Pipeline: Failed or was cancelled. Check logs |
Contributor
CI Development Pipeline Status✅ Pipeline: Completed successfully. View Run Details |
There was a problem hiding this comment.
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 --buildwill “spin up the development environment”, butdocker-compose.ymlcurrently runspython -m gitversionedwhich exits immediately. Either adjust the composeappcommand 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.
Contributor
CI Development Pipeline Status✅ Pipeline: Completed successfully. View Run Details |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
pyproject.tomlwith project-specific metadata, dependencies (Hatch/Setuptools hooks), and PEP 440 compliance settings.src/gitversioned/package layout andtests/directory.LICENSEandNOTICEfiles tailored for GitVersioned.ruff,mypy, andpytestconfigurations to enforce the "predictable and foolproof" nature of the project's future automation.Type of Change
Test Plan
ruff check .andmypy src/to ensure the empty package structure passes linting.pip install -e .executes successfully in a clean virtual environment.pyproject.tomlagainst standard PEP 621/518 schemas.Related Issues
Screenshots / Visuals (if applicable)
N/A - Initial structural commit.
Use of 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.gitversioned.