changelog 1.6.0

  • Readme
  • Changelog
  • Installing
  • 30

changelog for Dart #

Its main purpose is to write a file. You can also set the version of your pubspec.yaml according to the latest git tag. Helps with some "git" related stuff. (Mainly initializing the local repo)

Example output #

How to use it #

  1. Modify your source
  2. git commit -am "feature: My new, exciting feature"
  3. git tag v0.1.<increase prev. version> (e.g. if it was v0.1.0 - set it to v0.1.1)
  4. cl -x (This writes the new and updates the version in pubspec.yaml)
  5. git commit -am "Released v<your new version>" && git push && git publish

Installation #


    pub global activate changelog


    # activate changelog again
    pub global activate changelog


    pub global deactivate changelog

Usage + Workflow #

    # your commit with a "keyword"
    git commit -am "feature: This is my new feature"
    git tag 0.0.1 or git tag -am 0.0.1
    # Write and set the version in pubspec.yaml
    changelog -x
    # Push and the changed (version) pubspec.yaml to origin
    git commit -am "Released 0.0.1"
    git push origin master

    # push everything to your repo
    git push origin master
    # push it to pub
    pub publish 

-c - Writes
-y - Sets the version in your pubspec.yaml
-t - pushes all tags to your repo

"feature" is a commit keyword. Supported keywords are:

	feat      Sample: git commit -am "feat: <your message>"
	feature   Sample: git commit -am "feature: <your message>"
	chore     Sample: git commit -am "chore: <your message>"
	fix       Sample: git commit -am "fix: <your message>"
	fixes     Sample: git commit -am "fixes: <your message>"
	bug       Sample: git commit -am "bug: <your message>"
	bugs      Sample: git commit -am "bugs: <your message>"
	style     Sample: git commit -am "style: <your message>"
	doc       Sample: git commit -am "doc: <your message>"
	docs      Sample: git commit -am "docs: <your message>"
	refactor  Sample: git commit -am "refactor: <your message>"
	reorganizeSample: git commit -am "reorganize: <your message>"
	reorg     Sample: git commit -am "reorg: <your message>"
	test      Sample: git commit -am "test: <your message>"

All the other keywords are here

Instead of using changelog [options] you can also use `cl [options]

Commandline-options #

Usage: changelog [options]
    -h, --help          Shows this message
    -s, --settings      Prints settings
    -c, --changelog     Writes
    -k, --keys          Print CHANGELOG keywords (lables)
    -d, --simulation    Simulation, no write operations
    -y, --yaml          Set version in pubspec.yaml
    -t, --tags          Push tags to origin
    -x, --release       Combines -c -t and -y
    -i, --init          [ your GIT-Repo name ]
    -r, --domain        [ Domain where your repo is ]
    -v, --loglevel      [ info | debug | warning ]
    -a, --account       [ Your account @ GitHub, BitBucket... ]

    Write                                              'changelog -c'
    Set version in pubspec.yaml                                      'changelog -y'
    Write CHANGELOG, update Version in pubspec, push tags to origin: 'changelog -x'

    Init GitHub repo:           'changelog -a YourName -i yourrepo.git'
    Simulate initialisation:    'changelog -d -a YourName -i yourrepo.git'
    Simulate BitBucket init:    'changelog -d -r -a YourName -i yourrepo.git'

License #

Copyright 2015 Michael Mitterer (,
IT-Consulting and Development Limited, Austrian Branch

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
either express or implied. See the License for the specific language
governing permissions and limitations under the License.

If this tool is helpful for you - please (Circle) me.

Change Log for changelog #

Helps to write your

v1.6 - 2018-08-14 #

Feature #

  • Console-output comes without date + Logger-name 9f77003

Fixes #

Bugs #

  • Wrong param in Application.dart crashed the app 8a27354

Refactor #

  • Package is now Dart 2 only 8b70d20

v1.5 - 2017-09-11 #

Fixes #

  • Two-Digits version not allowed in pubspec.yaml 4be5aaf

Docs #

v1.4.2 - 2016-11-16 #

Docs #

v1.4.1 - 2016-10-24 #

Docs #

  • Readme shows 'How to use' this lib c7a2156

v1.4.0 - 2015-12-08 #

Docs #

v1.3.5 - 2015-11-02 #

Docs #

  • Better README, better constraints in pubspec 69fca9e

v1.3.2 - 2015-06-17 #

Bugs #

Docs #

  • Description in pubspec.yaml changed 53ce281

v1.3.0 - 2015-06-09 #

Refactor #

  • Renamed git-help to changelog f128d5b

v1.2.0 - 2015-03-09 #

Fixes #

  • Uses console_log_handler from packages and not from local path 932c983

v1.1.9 - 2015-02-25 #

Feature #

  • Added -x option. This options combines -c (Changelog) -y (set version in pubspec) and -t (push all tags to origin) b5793ab

v1.1.8 - 2015-02-20 #

Fixes #

  • Delete Changelog in simulation 7b9ee0a

v1.1.7 - 2015-02-20 #

Fixes #

  • Delete Changelog in simulation 01d4028

v1.1.6 - 2015-02-20 #

Feature #

  • -t pushes all Tags to your repo 2949cac

v1.1.5 - 2015-02-20 #

Feature #

  • Set 'changelogname' in yaml for nicer name e734ff9

v1.1.4 - 2015-02-20 #

Refactor #

  • Changed packagename to githelp (without dash) 57e2285

v1.1.3 - 2015-02-20 #

Fixes #

v1.1.2 - 2015-02-20 #

Fixes #

v1.1.1 - 2015-02-20 #

Fixes #

  • Better link for tag-headline caf6fb8

v1.1.0 - 2015-02-20 #

Feature #

  • Shows pubspec name and description in CHANGELOG 27c0473
  • Sets the version (latest tag) in pubspec.yaml e2bb5c2

Refactor #

  • Renamed git-init -> git-help 4ea063e

v1.0.1 - 2015-02-19 #

Feature #

  • It's possible to write a now 589f7df

This was generated with Changelog for Dart

Use this package as an executable

1. Install it

You can install the package from the command line:

$ pub global activate changelog

2. Use it

The package has the following executables:

$ changelog
$ cl

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  changelog: ^1.6.0

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:changelog/changelog.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Mar 27, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6

Health suggestions

Fix lib/src/Repo.dart. (-12.66 points)

Analysis of lib/src/Repo.dart reported 27 hints, including:

line 27 col 32: Unnecessary new keyword.

line 32 col 20: Unnecessary new keyword.

line 36 col 20: Unnecessary new keyword.

line 39 col 20: Unnecessary new keyword.

line 42 col 20: Unnecessary new keyword.

Fix lib/src/Application.dart. (-10.89 points)

Analysis of lib/src/Application.dart reported 23 hints, including:

line 4 col 28: Unnecessary new keyword.

line 8 col 31: Unnecessary new keyword.

line 14 col 35: Unnecessary new keyword.

line 19 col 17: Use isEmpty instead of length

line 78 col 27: Unnecessary new keyword.

Fix lib/src/LogSection.dart. (-7.24 points)

Analysis of lib/src/LogSection.dart reported 15 hints, including:

line 5 col 18: The value of the field '_logger' isn't used.

line 5 col 28: Unnecessary new keyword.

line 7 col 35: Unnecessary new keyword.

line 8 col 32: Unnecessary new keyword.

line 9 col 31: Unnecessary new keyword.

Fix additional 3 files with analysis or formatting issues. (-4.45 points)

Additional issues in the following files:

  • lib/src/Config.dart (7 hints)
  • bin/changelog.dart (1 hint)
  • lib/src/Options.dart (1 hint)

Maintenance issues and suggestions

Use analysis_options.yaml. (-10 points)

Change the name of your package's .analysis_options file to analysis_options.yaml.

Read more about the setup of analysis-options.yaml.

Package is getting outdated. (-61.64 points)

The package was last published 84 weeks ago.

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and changelog.dart. Packages with multiple examples should provide example/

For more information see the pub package layout conventions.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
args ^1.4.0 1.6.0
console_log_handler ^1.0.0 1.1.6
git_version ^0.3.0 0.3.0
intl >=0.15.2 <1.0.0 0.16.1
validate ^1.0.0 1.7.0
Transitive dependencies
analyzer 0.32.6 0.39.4
ansicolor 1.0.2
async 2.4.1
build 0.12.8 1.2.2
build_cli_annotations 1.2.0
charcode 1.1.3
collection 1.14.12
convert 2.1.1
crypto 2.1.4
csslib 0.16.1
front_end 0.1.4+2 0.1.29
glob 1.2.0
html 0.14.0+3
js 0.6.1+1
kernel 0.3.4+2 0.3.29
logging 0.11.4
meta 1.1.8
node_interop 1.0.3
node_io 1.0.1+2
package_config 1.9.3
path 1.6.4
pedantic 1.9.0
plugin 0.2.0+3
source_span 1.7.0
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
watcher 0.9.7+14
where 4.4.0 6.6.0
yaml 2.2.0
Dev dependencies
build_runner any
build_test any
build_web_compilers any
grinder any
test any