Skip to content

ricardoleal20/VersionWise

Repository files navigation

Tool for teams that manage the creation and modification of the CHANGELOG based on a specified set of changes.

Installation

To install VersionWise, you can do it through pip:

pip install versionwise

Please consider that it requires Python >=3.9

Usage

This Rust package, versionwise, provides several command-line tools for managing project versions and changesets. Below are the available commands and their usage examples.

Commands

create

Create a new changeset to document changes in the project.

versionwise create

This command creates a new changeset with the provided description.

list

List all changesets created for the project.

versionwise list

This command displays a list of all changesets recorded in the project, along with their descriptions and types.

bump

Bump the project version according to the specified type.

versionwise bump

This command increments the project version based on the specified type: major, minor, or patch. It updates the version number in the project files accordingly.

Also, it deletes all the current changesets to avoid changes


For more details on each command and its options, refer to the command-line help:

versionwise --help

Contributing

Everyone can contribute. Before contributing, please read our code of conduct.

To contribute to VersionWise, follow these steps:

  1. Fork this repository.
  2. Create a new branch.
  3. Make your changes and commit them.
  4. Push your changes to your fork.
  5. Create a pull request.

License

Project Name is released under the MIT License.

Inspiration

Inspired by Changesets.

About

<✏️> Tool for teams to manage the CHANGELOG given a list of different changes.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages