Skip to content

CLI orchestrator designed for semantic versioning, automated changelog generation, and release creation.

License

Notifications You must be signed in to change notification settings

yehezkieldio/castoria

Repository files navigation

Castoria

CLI orchestrator for managing releases, versioning, and changelog generation.

NPM Version GitHub Release GitHub Actions Workflow Status Formatted with Biome


Castoria is a personal and opinionated CLI tool for automatically bumping a project's version, generating a changelog powered by git-cliff, and creating a release on GitHub.

It is currently on early development and not ready for production use, or most use cases. It is being developed as a tool for personal use, and as a learning experience. Many features are still missing, and the current implementation is not stable.


Release Flow

After executing a bump command, Castoria will guide you through prompts and steps to prepare and publish a new release, you can also skip or automate some steps by providing flags or configuration.

Step Description
Verify Conditions Ensure the repository is in a clean state and all conditions are met.
Determine Version Bump Analyze commits for next version or prompt for a version bump.
Bump Version Update version in package manifest
Generate Changelog Process commit history with git-cliff
Create Git Commit Commit version bump and changelog updates
Create Git Tag Tag the release commit
Push Changes Update remote repository
Publish Release Create GitHub release

License and Attributions

Castoria is inspired by various release tools and workflows, including semantic-release, standard-version, cliff-jumper, release-it, and bumpp, among others.

This project is licensed under the MIT License. See the LICENSE file for more information.

About

CLI orchestrator designed for semantic versioning, automated changelog generation, and release creation.

Topics

Resources

License

Stars

Watchers

Forks

Packages