carto-devlog

Auto generated changelogs for developers.

What's carto-devlog?

carto-devlog is a cli tool written in javascript designed to auto generate changelogs on an easy way.

How to use

Installing

yarn add carto-devlog -dev

Generating a log

carto-devlog uses your git history to generate a log. Three parameters are required.

devlog -s <hash> -b <bump> -m <message> 

• Hash: Is the hash of the first commit to be included in the log. Usually the previous to the first version bump to be included.
• Bump: Is a regular expresion that should mach the version bumps.
• Message: Is a regular expresion that should mach the commits included in the log.

Do I need to change my git workflow?

carto-devlog can be used in any git project as long as your versions have a with a regular commit message but works the best when using github flow.

Just before merging a branch write feat:or fix: on your merge commit body and carto-devlog will add those commits to the right section.

Examples

### Example with github flow and labeled commits

Our git history looks like this, we only allow merges in the master branch and every merge is labeled.

64be965d2 (tag: v4.0.0-beta.11) Bump version to 4.0.0-beta.11
67c62256a Merge pull request #1990 from CartoDB/1984-refactor-tests
3fb47f46f Merge pull request #1986 from CartoDB/1942-feature-promise
e52f88fb0 (tag: v4.0.0-beta.10) Bump version to 4.0.0-beta.10
88f613bfa Merge pull request #1985 from CartoDB/1976-prevent-gridjson
418d47ac5 Merge pull request #1981 from CartoDB/1908-remove-moment
9cf1091aa (tag: v4.0.0-beta.9) Bump version to 4.0.0-beta.9
5d3d6ce41 Merge pull request #1978 from CartoDB/1974-use-window-leaflet

To generate a devlog we use:

devlog -s 5d3d6ce41 -b "Bump version to" -m "Merge pull request"

## 4.0.0-beta.11 - 2018-01-09

### New features
- Layer now returns a Promise
### Improvements
- Improved tests

## 4.0.0-beta.10 - 2017-12-29

### Fixes
- Prevent unnecessary gridjson fetches
### Improvements
- Remove moment to reduce bundle size

## 4.0.0-beta.9 - 2017-12-22

Example with a regular repo

Our git history looks like this.

64be965d2 (tag: v4.0.0-beta.11) Bump version to 4.0.0-beta.11
67c62256a Merge pull request #1990 from CartoDB/1984-refactor-tests
3e53c95e9 Apply CR suggestions
3fb47f46f Merge pull request #1986 from CartoDB/1942-feature-promise
4a80b02a8 Point to [email protected]
daae58281 Merge branch 'v4' into 1942-feature-promise
bdc8bccb8 Point to zera branch
e8d789c5d CR changes
e52f88fb0 (tag: v4.0.0-beta.10) Bump version to 4.0.0-beta.10
37e346d15 JSDoc for enum
ed814518a error and success events are public and have no namespace
716d16714 Fixed @typedef. Type is required!
9cf1091aa (tag: v4.0.0-beta.9) Bump version to 4.0.0-beta.9
b4f2abba8 Merge pull request #1992 from CartoDB/1071-decades

All releases have a Bump version to <version> commit.

To generate a devlog we just use:

devlog -s b4f2abba8 -b "Bump version to" -m ".*"

## 4.0.0-beta.11 - 2018-01-09

### Changes
- 1984-refactor-tests
- Apply CR suggestions
- Return Promises in setFeatureColumns functions
- Point to [email protected]
- Merge branch 'v4' into 1942-feature-promise
- Point to zera branch
- CR changes

## 4.0.0-beta.10 - 2017-12-29

### Changes
- JSDoc for enum
- error and success events are public and have no namespace
- Fixed @typedef. Type is required!

## 4.0.0-beta.9 - 2017-12-22