Some changelogs (mostly for libs) have specific "Breaking changes" section.

See example here:

• https://github.com/facebook/react/releases/tag/v16.0.0

Example:

1.0.0 (2018-10-25)

Breaking changes

• 💥 Change the API to get users list (#23) (e7c934a)

handlebars.js is a templating engine (used by conventional-changelog)

https://github.com/wycats/handlebars.js

This one is pure refactoring.
The core API should use from, to as parameter wherever is it possible

(instead of mode)

If you tag a version without executing gitmoji-changelog it will erase your changelog on next tag.

I'll provide an example as soon as possible

https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46

blacklist it so we don't see it in CHANGELOG file

It would be great if gitmoji-changelog can be interfaced with lerna publish.

One idea could be to use the last pushed lerna tag

Maybe this workflow?

1. publish with lerna
2. run gitmoji-changelog
3. commit --amend
4. retag

remove babel and use native node.js (v10)

The current algorithm should be changed:

1. Open CHANGELOG.md
2. For each line
   1. If line is not the previous tag: stream it to the tmp file
   2. If line is the previous tag:
      1. stream the NEW CHANGELOG into tmp file
      2. stream the rest of CHANGELOG.md to tmp file

Need to add e2e tests on the same model of https://github.com/frinyvonnick/gitmoji-changelog/blob/master/packages/gitmoji-changelog-cli/src/cli.e2e.spec.js

#50 (comment)

In next iteration we should weight group
In the screen I posted, it should be the commit with sparkles that should be the main one

#50 (comment)

It also move important commit types (like ✨) as sibling of less important ones (like 👌 ). For example, in the screenshot "✨ rien a voir (5ff7384)" should not be in the "Miscellaneous" group, but the "Added" group.

The idea is to work better with tools like lerna that have a publish command that generate a tag

We should display date next to tag's label

Example:

v1.0.0 - 20/08/2018

Uncouple cli from input and ouput, so we can have multiple input sources and output sources

Input sources

• http
• fs

Output sources

• http
• fs

Format

• json
• markdown
• asciidoc

Idea

Maybe we can do something like:

• gitmoji-changelog prepare

And the CLI ask us wich version we want next, like lerna publish do (or @lerna/versions ?):

• 1.0.0 (major)
• 0.1.0 (minor)
• 0.0.1 (patch)

And then continue

Cons

Maybe this is out of gitmoji-changelog idea

We can group together commit that are similars, like:

• :memo: update README.md
• :memo: README.md updated
• :memo: Update README.md

Should be grouped together so we can merge them manually after gitmoji-changelog is ran.

A good practice to allow build reproducibility is to fix all external dependencies :

• The FROM image should use the most precise tag available (ie. using the one containing the build date)
• all the packages installed should have pinned versions
• any external dependency should have a pinned version 😉

I get some emoijes not identified in some commits

See here an example on gitmoji-cli project (in the Misc part):

We should merge prerelease versions like alpha, beta, release candidate, ... when the matching release has been done.

Idea

Put the release changelog into github release pages.
We maybe need to add plugins to gitmoji-changelog (or middlewares in userland)

Cons

Maybe this is not the scope of gitmoji-changelog

See you monday to a PR ;)

First of all, thanks for this awesome lib 👍

Feature Request

Describe your idea
The user might want to manually select commits he wants in his changelog.

Describe what you'd like
When running gitmoji-changelog, display the list of commits and let the user unselect (all commits would be selected by default) the commits he don't want to add in the changelog.

Example :

> gitmoji-changelog
▶  start     gitmoji-changelog v1.1.0
Choose commits :
- [x] 🐛Fix bug
- [ ] 🔥Remove file
- [x] 📝Add doc

Hey, in #12 you sorted commit by emoji code then by date.

.sort((first, second) => {
          if (!first.emojiCode) return -1

          const emojiCriteria = first.emojiCode.localeCompare(second.emojiCode)
          if (emojiCriteria !== 0) return emojiCriteria
          return first.date.localeCompare(second.date)

It results a weird sorting, by emoji type, so a bit "randomly".
An example here:

where we should have the first commit (🎉), then some couples of features and the tests associated to them (so couples of "✨ followed by ✅").

My opinion is that inside a category we should sort the commits by date and nothing else, and that the commits should be sorted newer at up.

I can do the PR for that if you want.
Thanks for your work.
Matt'

2 issues identified with incremental writing:

• When I use incremental writing several times, it doesn't delete the last incremental added version
• A line is added at the end of the file for each incremental writing

Here a video to explain it:
https://www.useloom.com/share/888d83d584dd42db83e2daeacd41bdb9

#53 (comment)

Rename the package to gitmoji-changelog-template or gitmoji-changelog-format
Add a middleware system:

• core
• markdown
• etc

Each format should have:

• a template (with handlebars), example: template.md
• a mapping routine that uses previous middlewares, example: generateMarkdown.js:
  • 1st middleware: core()
  • 2nd middleware: markdown()

We should reflect the hierarchy in markdown using right heading.

• # for major release
• ## for minor release
• ### for patch release

Example:

v2.0.0

• Some other commit

v1.1.0

• Some other commit

v1.0.1

• Some other commit

v1.0.0

• Some commit

• Handle automatically multiple technologies (node, maven, makefile, config file if nothing found)
• 2 versions of middleware one that respect data format handled by gitmoji-changelog and a second one which take a template for more flexibility

Add link about images version supported and a link to Docker Hub

https://github.com/substack/semver-compare

Lerna publish command has a canary option that could be used in CI

When there is no new commit, gitmoji-changelog will generate an empty release.
It should not generate anything and throw an error or warning in the CLI saying that there is no new commit to generate changelog. (maybe propose to git fetch origin if user forget to get last commits)

Types of changes:

• Added for new features.
• Changed for changes in existing functionality.
• Deprecated for soon-to-be removed features.
• Removed for now removed features.
• Fixed for any bug fixes.
• Security in case of vulnerabilities.

Those types of changes are extracts from https://keepachangelog.com/en/1.0.0/

On the @frinyvonnick docker account to have same name that this repository

Maybe you could group lignes of changelog ?
Imagine this commit log:

1. :sparkles: screen / users / add
2. :sparkles: screen / todo / list
3. :sparkles: screen / users / remove

It would be nice that this changelog is generated:

## Added
 - screen / users / add
 - screen / users / remove
 - screen / todo / list

order: 1 - 3 - 2 // or 3 - 1 - 2

Then I can manually group by screen if I want to :)

If you don't want to, can you think about a middleware implementation instead of writing the lib bar.

Writing the example, a middleware implementation would be a must have for me :)
I could group by screen my myself ;)

git-repo-info seems to be the solution. We need to figure out if it fullfills all our needs

Use of a logger:

• to manage a debug or verbose mode (gitmoji-changelog --debug)
• to have a beautiful output ;)

This one seems great: https://github.com/klauscfhq/signale

We should support short commit SHA as URL https://help.github.com/articles/autolinked-references-and-urls/#commit-shas

Pros

• We don't need to have git (the CLI)
• We don't need to have a specific git version

Cons

• We can't use our current dependencies (like git-raw-commits)

So gitmoji-changelog works not only for node projects

We should add instructions in the README.md to explain how to install alpha version of gitmoji-changelog

npm install -g gitmoji-changelog@alpha

I just published a version using lerna version since I can't figure out how to use correctly lerna publish.

Firstly I used the command lerna version premajor to bump an alpha version in every packages. Then I used the command yarn publish --tag alpha and type the current version in the prompt
in each package to publish this version to npm.

After this, I had to execute gitmoji-changelog and amend release commit and move the git tag and push force it on master.

We must order commits by emoji in the same order as in the mapping file and within a type by date

Add an option so each commit is suffixed by its author.
This great for opensource :)