semversioner 2.2.0__tar.gz → 3.0.0__tar.gz

{semversioner-2.2.0 → semversioner-3.0.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Raul Gomis
+Copyright (c) 2020-2026 Raul Gomis
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

semversioner-3.0.0/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: semversioner
+Version: 3.0.0
+Summary: Manage properly semver in your repository
+Author-email: Raul Gomis <raulgomis@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2020-2026 Raul Gomis
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/raulgomis/semversioner
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: packaging>=21.0
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
+Requires-Dist: importlib_resources>=6.0.0; extra == "dev"
+Requires-Dist: ruff>=0.9.0; extra == "dev"
+Dynamic: license-file
+
+# Semversioner
+
+The easiest way to manage [semantic versioning](https://semver.org/) in your project and generate `CHANGELOG.md` files automatically.
+
+Semversioner provides the tooling to automate the semver release process for libraries, docker images, microservices, and more.
+
+This project was inspired by the way AWS manages their versioning for [AWS-cli](https://github.com/aws/aws-cli/).
+
+[![PyPI Version](https://img.shields.io/pypi/v/semversioner.svg)](https://pypi.org/project/semversioner/)
+
+## Semantic Versioning
+
+The [semantic versioning](https://semver.org/) spec involves several possible variations, but to simplify, in _Semversioner_ we are using the three-part version number:
+
+`<major>.<minor>.<patch>`
+
+Constructed with the following guidelines:
+
+- Breaking backward compatibility or major features bumps the **major** (and resets the minor and patch).
+- New additions without breaking backward compatibility bumps the **minor** (and resets the patch).
+- Bug fixes and misc changes bumps the **patch**.
+
+An example would be `1.0.0`.
+
+## How it works
+
+At any given time, the `.semversioner/` directory looks like:
+
+```text
+.semversioner
+├── next-release
+│   ├── minor-20181227010225.json
+│   └── major-20181228010225.json
+├── 1.1.0.json
+├── 1.1.1.json
+└── 1.1.2.json
+```
+
+The release process takes everything in the `next-release` directory and aggregates them all together in a single JSON file for that release (e.g., `1.12.0.json`). This JSON file is a list of all the individual JSON files from `next-release`.
+
+## Install
+
+```shell
+pip install semversioner
+```
+
+## Usage
+
+You can use the `--help` option on any command to see the available options:
+
+```shell
+semversioner --help
+```
+
+### Adding changesets
+
+In your local environment, you can use the CLI to create the different changeset files that will be committed with your code. This ensures that every pull request or commit contains its own self-contained change description and version bump intention.
+
+```shell
+semversioner add-change --type patch --description "Fix security vulnerability with authentication."
+```
+
+Allowed `--type` values are: `major`, `minor`, `patch`.
+
+You can also add custom attributes to the changeset file that will be available later in your release template. Use the `--attributes` flag in `key=value` format (you can pass it multiple times):
+
+```shell
+semversioner add-change --type patch \
+    --description "My custom changelog message with attributes." \
+    --attributes pr_id=322 \
+    --attributes issue_id=123
+```
+
+### Checking working directory status
+
+You can check the status of your working directory to see the current version, the computed next version, and any unreleased changes:
+
+```shell
+semversioner status
+```
+
+Example output:
+
+```text
+Version: 1.0.0
+Next version: 1.1.0
+Unreleased changes:
+	minor:	Added new authentication feature
+(use "semversioner release" to release the next version)
+```
+
+### Enforcing changesets in CI/CD (Check)
+
+In your CI/CD pipeline, it's often useful to enforce that a PR includes a changeset before merging. You can use the `check` command to verify that there are unreleased changes in the `.semversioner/next-release/` directory.
+
+```shell
+semversioner check
+```
+
+If no changes are found, the command exits with a non-zero status code (`-1`) and prints an error message.
+
+### Releasing a new version
+
+When you are ready to create a release (usually in your CI/CD tool on the main branch), you run the `release` command. This automatically computes the new version number based on the unreleased changes, generates a new version JSON file, and clears the `next-release` directory.
+
+```shell
+semversioner release
+```
+
+### Generating the Changelog
+
+As part of your release workflow, you can generate the changelog file with all aggregated changes.
+
+```shell
+semversioner changelog > CHANGELOG.md
+```
+
+#### Customizing the changelog template
+
+You can customize the changelog by creating a template and passing it as a parameter to the command. For example:
+
+```shell
+semversioner changelog --template .semversioner/config/template.j2
+```
+
+The template uses [Jinja2](https://jinja.palletsprojects.com/en/3.1.x/), a templating language for Python. A basic example:
+
+```jinja2
+# Changelog
+{% for release in releases %}
+
+## {{ release.version }}
+
+{% for change in release.changes %}
+- {{ change.type }}: {{ change.description }}
+{% endfor %}
+{% endfor %}
+```
+
+If you included custom attributes (e.g., `pr_id`, `issue_id`) using the `add-change` command, you can reference them in your template. You also have access to `current_version`:
+
+```jinja2
+# Changelog
+Note: version releases in the 0.x.y range may introduce breaking changes.
+
+# Current version: {{ current_version }}
+
+{% for release in releases %}
+
+## {{ release.version }}{{ ' (' + release.created_at.strftime('%Y-%m-%d') + ')' if release.created_at }}
+
+{% for change in release.changes %}
+- {{ change.type }}: {{ change.description }}{{ ' (#' + change.attributes.pr_id + ')' if change.attributes }}{{ ' (J' + change.attributes.issue_id + ')' if change.attributes }}
+{% endfor %}
+{% endfor %}
+```
+
+#### Filtering the changelog
+
+You can filter the changelog by only showing changes for a specific version:
+
+```shell
+semversioner changelog --version "1.0.0"
+```
+
+Alternatively, you can filter changes for the last released version:
+
+```shell
+semversioner changelog --version $(semversioner current-version)
+```
+
+### Getting the current version
+
+You can retrieve the currently released version of your project:
+
+```shell
+semversioner current-version
+```
+
+### Getting the next version
+
+As part of the CI/CD workflow, sometimes you want to release dev, rc, or other pre-release packages. For this purpose, the `next-version` command can be issued to compute the upcoming version based on the current changeset. This will not modify any files on disk.
+
+```shell
+semversioner next-version
+```
+
+## Global Options
+
+- `--path`: Specify a custom base path for your project. Defaults to the current directory. Example: `semversioner --path /path/to/project release`
+
+## License
+
+Copyright (c) 2026 Raul Gomis.
+MIT licensed, see [LICENSE](LICENSE) file.
+
+---
+Made with ♥ by [Raul Gomis](https://twitter.com/rgomis).

semversioner-3.0.0/README.md

@@ -0,0 +1,198 @@
+# Semversioner
+
+The easiest way to manage [semantic versioning](https://semver.org/) in your project and generate `CHANGELOG.md` files automatically.
+
+Semversioner provides the tooling to automate the semver release process for libraries, docker images, microservices, and more.
+
+This project was inspired by the way AWS manages their versioning for [AWS-cli](https://github.com/aws/aws-cli/).
+
+[![PyPI Version](https://img.shields.io/pypi/v/semversioner.svg)](https://pypi.org/project/semversioner/)
+
+## Semantic Versioning
+
+The [semantic versioning](https://semver.org/) spec involves several possible variations, but to simplify, in _Semversioner_ we are using the three-part version number:
+
+`<major>.<minor>.<patch>`
+
+Constructed with the following guidelines:
+
+- Breaking backward compatibility or major features bumps the **major** (and resets the minor and patch).
+- New additions without breaking backward compatibility bumps the **minor** (and resets the patch).
+- Bug fixes and misc changes bumps the **patch**.
+
+An example would be `1.0.0`.
+
+## How it works
+
+At any given time, the `.semversioner/` directory looks like:
+
+```text
+.semversioner
+├── next-release
+│   ├── minor-20181227010225.json
+│   └── major-20181228010225.json
+├── 1.1.0.json
+├── 1.1.1.json
+└── 1.1.2.json
+```
+
+The release process takes everything in the `next-release` directory and aggregates them all together in a single JSON file for that release (e.g., `1.12.0.json`). This JSON file is a list of all the individual JSON files from `next-release`.
+
+## Install
+
+```shell
+pip install semversioner
+```
+
+## Usage
+
+You can use the `--help` option on any command to see the available options:
+
+```shell
+semversioner --help
+```
+
+### Adding changesets
+
+In your local environment, you can use the CLI to create the different changeset files that will be committed with your code. This ensures that every pull request or commit contains its own self-contained change description and version bump intention.
+
+```shell
+semversioner add-change --type patch --description "Fix security vulnerability with authentication."
+```
+
+Allowed `--type` values are: `major`, `minor`, `patch`.
+
+You can also add custom attributes to the changeset file that will be available later in your release template. Use the `--attributes` flag in `key=value` format (you can pass it multiple times):
+
+```shell
+semversioner add-change --type patch \
+    --description "My custom changelog message with attributes." \
+    --attributes pr_id=322 \
+    --attributes issue_id=123
+```
+
+### Checking working directory status
+
+You can check the status of your working directory to see the current version, the computed next version, and any unreleased changes:
+
+```shell
+semversioner status
+```
+
+Example output:
+
+```text
+Version: 1.0.0
+Next version: 1.1.0
+Unreleased changes:
+	minor:	Added new authentication feature
+(use "semversioner release" to release the next version)
+```
+
+### Enforcing changesets in CI/CD (Check)
+
+In your CI/CD pipeline, it's often useful to enforce that a PR includes a changeset before merging. You can use the `check` command to verify that there are unreleased changes in the `.semversioner/next-release/` directory.
+
+```shell
+semversioner check
+```
+
+If no changes are found, the command exits with a non-zero status code (`-1`) and prints an error message.
+
+### Releasing a new version
+
+When you are ready to create a release (usually in your CI/CD tool on the main branch), you run the `release` command. This automatically computes the new version number based on the unreleased changes, generates a new version JSON file, and clears the `next-release` directory.
+
+```shell
+semversioner release
+```
+
+### Generating the Changelog
+
+As part of your release workflow, you can generate the changelog file with all aggregated changes.
+
+```shell
+semversioner changelog > CHANGELOG.md
+```
+
+#### Customizing the changelog template
+
+You can customize the changelog by creating a template and passing it as a parameter to the command. For example:
+
+```shell
+semversioner changelog --template .semversioner/config/template.j2
+```
+
+The template uses [Jinja2](https://jinja.palletsprojects.com/en/3.1.x/), a templating language for Python. A basic example:
+
+```jinja2
+# Changelog
+{% for release in releases %}
+
+## {{ release.version }}
+
+{% for change in release.changes %}
+- {{ change.type }}: {{ change.description }}
+{% endfor %}
+{% endfor %}
+```
+
+If you included custom attributes (e.g., `pr_id`, `issue_id`) using the `add-change` command, you can reference them in your template. You also have access to `current_version`:
+
+```jinja2
+# Changelog
+Note: version releases in the 0.x.y range may introduce breaking changes.
+
+# Current version: {{ current_version }}
+
+{% for release in releases %}
+
+## {{ release.version }}{{ ' (' + release.created_at.strftime('%Y-%m-%d') + ')' if release.created_at }}
+
+{% for change in release.changes %}
+- {{ change.type }}: {{ change.description }}{{ ' (#' + change.attributes.pr_id + ')' if change.attributes }}{{ ' (J' + change.attributes.issue_id + ')' if change.attributes }}
+{% endfor %}
+{% endfor %}
+```
+
+#### Filtering the changelog
+
+You can filter the changelog by only showing changes for a specific version:
+
+```shell
+semversioner changelog --version "1.0.0"
+```
+
+Alternatively, you can filter changes for the last released version:
+
+```shell
+semversioner changelog --version $(semversioner current-version)
+```
+
+### Getting the current version
+
+You can retrieve the currently released version of your project:
+
+```shell
+semversioner current-version
+```
+
+### Getting the next version
+
+As part of the CI/CD workflow, sometimes you want to release dev, rc, or other pre-release packages. For this purpose, the `next-version` command can be issued to compute the upcoming version based on the current changeset. This will not modify any files on disk.
+
+```shell
+semversioner next-version
+```
+
+## Global Options
+
+- `--path`: Specify a custom base path for your project. Defaults to the current directory. Example: `semversioner --path /path/to/project release`
+
+## License
+
+Copyright (c) 2026 Raul Gomis.
+MIT licensed, see [LICENSE](LICENSE) file.
+
+---
+Made with ♥ by [Raul Gomis](https://twitter.com/rgomis).

semversioner-3.0.0/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "semversioner"
+dynamic = ["version"]
+description = "Manage properly semver in your repository"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Raul Gomis", email = "raulgomis@gmail.com"}
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "click>=8.0.0",
+    "jinja2>=3.0.0",
+    "packaging>=21.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=9.0.0",
+    "pytest-cov>=6.0.0",
+    "importlib_resources>=6.0.0",
+    "ruff>=0.9.0",
+]
+
+[project.scripts]
+semversioner = "semversioner.__main__:main"
+
+[project.urls]
+Homepage = "https://github.com/raulgomis/semversioner"
+
+[tool.setuptools]
+packages = ["semversioner"]
+
+[tool.setuptools.dynamic]
+version = {attr = "semversioner.__version__.__version__"}
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "C90", "N", "UP", "B", "A", "C4", "PT", "ARG", "RET", "SIM", "PTH", "ERA"]
+ignore = ["E501"]
+
+[tool.ruff.lint.per-file-ignores]
+"semversioner/__init__.py" = ["F401"]
+"tests/*" = ["ARG001", "ARG002", "PTH", "PT"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["semversioner"]

semversioner-3.0.0/semversioner/__init__.py

@@ -0,0 +1,14 @@
+from semversioner.__version__ import __version__
+from semversioner.core import Semversioner
+from semversioner.models import (
+    Changeset,
+    MissingChangesetError,
+    Release,
+    ReleaseStatus,
+    ReleaseType,
+    SemversionerError,
+)
+from semversioner.storage import (
+    SemversionerFileSystemStorage,
+    SemversionerStorage,
+)

semversioner-3.0.0/semversioner/__version__.py

@@ -0,0 +1 @@
+__version__ = "3.0.0"