conventional_semver

v0.2.6

CLI tool for deciding the next semantic version of the project, using conventional commits. For more information about how to use this package see README

Latest version published 9 months ago

License: GPLv3

PyPI

GitHub

Package Health Score

53 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Popularity

Limited

GitHub Stars: 0
Forks: 0
Contributors: 1

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package conventional_semver, we found that it has been starred ? times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jan 11, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

GPLv3

Security Policy

We found a way for you to contribute to the project! Looks like conventional_semver is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 9 months ago
Last Commit: 9 months ago

Further analysis of the maintenance status of conventional_semver based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that conventional_semver demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like conventional_semver is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.12,<4.0

Age: 9 months
Latest Release: 9 months ago
Dependencies: 4 Direct
Versions: 2
Maintainers: 1
Wheels: OS Independent

Readme

Bump your Semantic Version using Conventional Commits

A Python CLI tool for calculating how to bump a Semantic Version based on a commit message.

Installation and Usage

$> pip install conventional_semver

Configuration

Create a .toml file and modify the settings you want to be different from the PCCC defaults. An example config.toml file is present in this repository.

Usage

The most basic usage of this tool is to create a config file as described above and pass a conventional commit message as input to the script.

$> conventional_semver "fix: ensure /api/list-all returns properly"
$> 0.0.1

It is also possible to provide a SemVer as an argument and have the script calculate the next version:

$> conventional_semver --semver 1.0.8 "feat: add new cool feature"
$> 1.1.0

The tool also supports the SemVer options for pre-releases and build metadata, using --pre-release and --build-meta, which will append the provided strings in a SemVer compatible manner.

$> conventional_semver --semver 1.0.8 --pre-release alpha.1 --build-meta $(date -u +"%Y-%m-%dT%H:%M:%SZ") "feat: add new cool feature"
$> 1.1.0-alpha.1+2024-01-11T07:21:57Z

Note that the lib used for SemVer parsing is a bit more relaxed than the official documentation, w.r.t. pre-release and build metadata. Make sure the strings provided follow the SemVer specification!

Pipeline example

This tool is particularly useful if you work trunk based, as you can use it in combination with the information already present in your git repository to automatically tag your new commit. I have created a sample project where I show how to use the tool in a GitHub Workflow, both for validating PRs and for tagging new commits on main.

Dependencies

The tool relies on The Python Conventional Commit Parser for the validation of the commit message and on Python SemanticVersion for managing the Semantic Version. The former of these use the Enchant C Library used by PyEnchant.

conventional_semver dependencies

gitpython loguru pccc semantic-version

FAQs

What is conventional_semver?

CLI tool for deciding the next semantic version of the project, using conventional commits. Visit Snyk Advisor to see a full health score report for conventional_semver, including popularity, security, maintenance & community analysis.

Is conventional_semver popular?

The python package conventional_semver receives a total of 56 weekly downloads. As such, conventional_semver popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is conventional_semver well maintained?

We found indications that conventional_semver is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is conventional_semver safe to use?

The python package conventional_semver was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 3 October-2024, at 07:54 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP