Welcome to the CCV repository! This project focuses on streamlining the versioning process in your development workflow using Conventional Commits. By adopting a standardized commit message format, you can automate versioning and changelog generation, making your release process smoother and more efficient.
In today's fast-paced development environment, maintaining a clear and consistent versioning strategy is crucial. CCV leverages the Conventional Commits specification to enhance your versioning process. This repository integrates seamlessly with GitHub Actions, allowing for automated workflows that reduce manual errors and save time.
Conventional Commits is a specification for writing standardized commit messages. This approach helps in automatically determining the type of changes made in your project. It categorizes commits into types like feat, fix, and chore, which makes it easier to understand the history of your project.
- Automated Versioning: Automatically increment your version number based on commit types.
- Changelog Generation: Create changelogs based on commit messages.
- GitHub Actions Integration: Use GitHub Actions for continuous delivery.
- Customizable: Easily adapt the configuration to suit your project's needs.
To get started with CCV, follow these steps:
-
Clone the repository:
git clone https://github.com/Kaks734/ccv.git
-
Navigate to the project directory:
cd ccv -
Install the necessary dependencies:
npm install
Once you have installed CCV, you can start using it in your project.
-
Set up your commit message format. You can use the following types:
feat: A new featurefix: A bug fixchore: Changes to the build process or auxiliary tools
-
Make your commits using the conventional format:
git commit -m "feat: add new user authentication" -
Run the versioning command to update your version based on the commits:
npm run version
-
Generate a changelog with the following command:
npm run changelog
For the latest releases and updates, visit our Releases section. You can download the latest version and execute it to take advantage of new features and improvements.
If you are looking for a specific release, please check the Releases section for detailed information.
We welcome contributions to enhance the CCV project. If you want to contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature:
git checkout -b feature/my-feature
- Make your changes and commit them:
git commit -m "Add my feature" - Push to your forked repository:
git push origin feature/my-feature
- Create a pull request.
Please ensure that your code adheres to the project's coding standards and includes appropriate tests.
This project is licensed under the MIT License. See the LICENSE file for details.
Thank you for checking out CCV! We hope this tool makes your versioning process easier and more efficient. Happy coding!