changelog 1.4.2

changelog for Dart

Its main purpose is to write a <strong>CHANGELOG.md</strong> 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

  • https://github.com/MikeMitterer/dart-changelog/blob/master/CHANGELOG.md

How to use it

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

Installation

Install

    pub global activate changelog

Update

    # activate changelog again
    pub global activate changelog

Uninstall

    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 CHANGELOG.md and set the version in pubspec.yaml
    changelog -x
    
    # Push CHANGELOG.md 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 CHANGELOG.md<br> -y - Sets the version in your pubspec.yaml<br> -t - pushes all tags to your repo

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

Labels:
	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 CHANGELOG.md
    -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... ]

Sample:
    Write CHANGELOG.md:                                              '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 bibucket.org -a YourName -i yourrepo.git'

License

Copyright 2015 Michael Mitterer (office@mikemitterer.at),
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

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
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 CHANGELOG.md

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 CHANGELOG.md now 589f7df

This CHANGELOG.md was generated with Changelog for Dart

1. Depend on it

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

dependencies:
  changelog: "^1.4.2"

2. Install it

You can install packages from the command line:

$ pub get

Alternatively, your editor might support pub. 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';

About

Helps to write your CHANGELOG.md

Author

Email office@mikemitterer.at office@mikemitterer.at

Homepage

github.com/MikeMitterer/dart-git-help

Documentation

www.dartdocs.org/documentation/changelog/1.4.2/

Source code (hyperlinked)

www.crossdart.info/p/changelog/1.4.2/

Uploader

office@mikemitterer.at

Share