diff --git a/.gitignore b/.gitignore index 8b713fc..b2ecd2e 100644 --- a/.gitignore +++ b/.gitignore @@ -34,4 +34,6 @@ Thumbs.db # Other common files to ignore *.swp *.bak -*.swo \ No newline at end of file +*.swo +/tests/.pytest_cache/ +/.pytest_cache/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8fd9998 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) +and this project adheres to [Semantic Versioning](http://semver.org/). + +## [Unreleased] - 2025-10-28 + +### Added +- Initial release +- Git tag management with SemVer support +- Gitflow branching model support +- Development, RC, patch, and production tag handling + +### Changed + +### Fixed diff --git a/README.md b/README.md index eb002e3..4a6e229 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ A Python class to manage Git tags following **Semantic Versioning (SemVer)** and It provides utilities to create, increment, and validate **development**, **release candidate (RC)**, **patch**, and **production** tags. --- +## 📖 Documentation +📚 [Live Documentation](https://0jas.github.io/vcm/) ## 🚀 Features @@ -81,7 +83,7 @@ The project follows the Gitflow branching model: * **patch | hotfix/** → created from `master`. * **master** → production-ready branch. -Below is the **Git Flow diagram**. Click on it to open **HTML** version. +Below is the **Git Flow diagram**. [](assets/html/GitFlow.html) --- diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..cfeb065 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,8 @@ +# Version Control Manager + +Welcome to the documentation for the **Version Control Manager** project. + +This site includes: + +- **Source Code** — Documentation generated directly from the `src/` package. +- **Test(s)** — Documentation generated directly from the `tests/` suite. diff --git a/docs/src.md b/docs/src.md new file mode 100644 index 0000000..9ac3277 --- /dev/null +++ b/docs/src.md @@ -0,0 +1,3 @@ +# Source Code + +::: src.vcm diff --git a/docs/tests.md b/docs/tests.md new file mode 100644 index 0000000..3ef9656 --- /dev/null +++ b/docs/tests.md @@ -0,0 +1,3 @@ +# Tests + +::: tests.test_vcm diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..395570f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,17 @@ +site_name: Version Control Manager(VCM) Documentation +nav: + - Home: index.md + - Source Code: src.md + - Test(s): tests.md + +plugins: + - search + - mkdocstrings: + default_handler: python + +theme: + name: material + features: + - navigation.expand + - navigation.sections + - toc.integrate diff --git a/requirements.txt b/requirements.txt index 81b2c61..32ce939 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,18 +1,4 @@ -click==8.0.3 -exceptiongroup==1.3.0 -Flask==2.0.2 -gitdb==4.0.12 GitPython==3.1.45 -iniconfig==2.1.0 -itsdangerous==2.0.1 -Jinja2==3.0.3 -MarkupSafe==2.0.1 -packaging==25.0 -pluggy==1.6.0 -Pygments==2.19.2 pytest==8.4.2 semver==3.0.4 -smmap==5.0.2 -tomli==2.2.1 -typing_extensions==4.15.0 -Werkzeug==2.0.2 +setuptools==57.0.0 diff --git a/site/404.html b/site/404.html new file mode 100644 index 0000000..116c5f4 --- /dev/null +++ b/site/404.html @@ -0,0 +1,307 @@ + + + +
+ + + + + + + + + + + + + + +