This repository houses the source code for sct, the simple changelog tool. It's a tool which allows a changelog to be generated based on version control system commits. We already should be writing good commit messages, so why not go a little farther, write commit messages a little better, and then automatically generate a changelog on demand.
Currently sct only supports projects which are using git and semantic versioning.
Currently there are two main ways you can use sct.
- Via build tool plugin - This is the recommended way to use sct. See https://github.com/bzumhagen/sbt-sct for a plugin for sbt. Maven plugin not currently available.
- Via source / source assembly - If you want to go this route, check out the rest of the steps below.
- Java 8
- SBT
brew install sbt
Clone the repository
git clone https://github.com/bzumhagen/sct.git
CD into the project directory
cd sct
Compile the project
sbt compile
Run the project
sbt run
View the generated changelog
cat changelog.md
sbt test
sbt assembly
- Dropwizard - The web framework used
- Maven - Dependency Management
- ROME - Used to generate RSS Feeds
No contributing guide yet.
We use SemVer for versioning.
- Ben Zumhagen - Initial work - Github
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Thanks to KeepAChangelog for the formatting inspiration. Sorry I based the project around breaking the rule at the top of your page "Don’t let your friends dump git logs into changelogs."
