- Notifications
You must be signed in to change notification settings - Fork44
Generate beautiful changelogs from your Git commit history
License
clog-tool/clog-cli
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Aconventional changelog for the rest of us
clog creates a changelog automatically from your local git metadata. See theclogschangelog.md for an example.
The way this works, is every time you make a commit, you ensure your commit subject line follows theconventional format. Then when you wish to update your changelog, you simply runclog inside your local repository with any options you'd like to specify.
NOTE:clog also supports empty components by making commit messages such asalias: message oralias(): message (i.e. without the component)
There are two ways to useclog, via the command line or a library in your applicaitons.
USAGE: clog [FLAGS] [OPTIONS]FLAGS: -F, --from-latest-tag use latest tag as start (instead of --from) -h, --help Printshelp information -M, --major Increment major version by one (Sets minor and patch to 0) -m, --minor Increment minor version by one (Sets patch to 0) -p, --patch Increment patch version by one -V, --version Prints version informationOPTIONS: -c, --config<config> The Clog Configuration TOML file to use (Defaults to'.clog.toml')** -f, --from<from> e.g. 12a8546 -g, --git-dir<gitdir> Local .git directory (defaults to current dir +'.git')* -o, --outfile<outfile> Where to write the changelog (Defaults to'changelog.md') -r, --repository<repo> Repo usedfor link generation (without the .git, e.g. https://github.com/thoughtram/clog) -l, --link-style<style> The style of repository link to generate (Defaults to github) [values: Github, Gitlab, Stash] -s, --subtitle<subtitle> e.g."Crazy Release Title" -t, --to<to> e.g. 8057684 (Defaults to HEAD when omitted) --setversion<ver> e.g. 1.0.1 -w, --work-tree<workdir> Local working tree of the git project (defaults to current dir)** If your .git directory is a child of your project directory (most common, such as/myproject/.git) AND notin the current working directory (i.e you need to use --work-tree or--git-dir) you only need to specify either the --work-tree (i.e. /myproject) OR --git-dir (i.e. /myproject/.git), you don't need to use both.** If using the --config to specify a clog configuration TOML file NOT in the current workingdirectory (meaning you need to use --work-tree or --git-dir) AND the TOML file is inside yourproject directory (i.e. /myproject/.clog.toml) you do not need to use --work-tree or --git-dir.
Clone the repo
git clone https://github.com/thoughtram/clog && cd clogBuild clog
cargo build --releaseDelete the old changelog file
rm changelog.mdRun clog
./target/release/clog -r https://github.com/thoughtram/clog --setversion 0.1.0 --subtitle crazy-dog --from 6d8183f
See the documentation for information on usingclog in your applications.
- Clone the
clogrepo so that you have something to search through (Becauseclogusesspecially formatted commit messages)
$ git clone https://github.com/thoughtram/clog ~/clog- Add
clogas a dependency in yourCargo.toml
[dependencies]clog ="*"
- Use the following in your
src/main.rs
externcrate clog;use clog::Clog;fnmain(){// Create the structletmut clog =Clog::with_dir("~/clog").unwrap_or_else(|e|{println!("{}",e); std::process::exit(1);});// Set some options clog.repository("https://github.com/thoughtram/clog").subtitle("Crazy Dog").from("6d8183f").version("0.1.0");// Write the changelog to the current working directory//// Alternatively we could have used .write_changelog_to("/somedir/some_file.md") clog.write_changelog();}
- Compile and run `$ cargo build --release && ./target/release/bin_name
- View the output in your favorite markdown viewer!
$ vim changelog.md
clog can also be configured using a default configuration file so that you don't have to specify all the options each time you want to update your changelog. To do this add a.clog.toml file to your repository.
[clog]repository ="https://github.com/thoughtram/clog"subtitle ="my awesome title"# specify the style of commit links to generate, defaults to "github" if omittedlink-style ="github"# sets the changelog output file, defaults to "changelog.md" if omittedoutfile ="MyChangelog.md"# If you use tags, you can set the following if you wish to only pick# up changes since your latest tagfrom-latest-tag =true
Now you can update yourMyChangelog.md withclog --patch (assuming you want to update from the latest tag version, and increment your patch version by 1).
Note: Any options you specify at the command line will override options set in your.clog.toml
By default,clog will display two sections in your changelog,Features andBug Fixes. You can add additional sections by using a.clog.toml file. To add more sections, simply add a[sections] table, along with the section name and aliases you'd like to use in your commit messages:
[sections]MySection = ["mysec","ms"]
Now if you make a commit message such asmysec(Component): some message orms(Component): some message there will be a new "MySection" section along side the "Features" and "Bug Fixes" areas.
NOTE: Sections with spaces are suppported, such as"My Special Section" = ["ms", "mysec"]
clog is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.
About
Generate beautiful changelogs from your Git commit history
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.