🐳 Init dockerfile

[lhauspie]

I had 2 options to write this Dockerfile:

1. Build the gitmoji-changelog "binary" from source
2. Install the binary from npm registry

Even if the second option offers a lighter Docker Image (102MB) compared to the first one (263MB), I chose the first one because I think we cannot build a Docker Image based on "binary" from "https://registry.npmjs.org/gitmoji-changelog" until it is available (but I maybe wrong, just tell me).

So, this Dockerfile:

• copy sources of gitmoji-changelog
• then build them by using yarn
• and define the entrypoint to /usr/src/gitmoji-changelog/node_modules/.bin/gitmoji-changelog

Usage

docker run --rm -v $(pwd):/usr/src/app gitmoji-changelog where $(pwd) is the folder of the project you want to generate the CHANGELOG.md.

All Commands, Positionals and Options are available with docker run command.
For instance, docker run --rm -v $(pwd):$(pwd) -w $(pwd) gitmoji-changelog:1.0.0 --help outputs:

Usage: gitmoji-changelog <command> [options]

Commands:
  gitmoji-changelog [release]         Generate changelog               [default]
  gitmoji-changelog init              Initialize changelog from tags
  gitmoji-changelog update [release]  Update changelog with a new version

Positionals:
  release  Next version (from-package, next)           [default: "from-package"]

Options:
  --version  Show version number                                       [boolean]
  --format   changelog format (markdown, json)             [default: "markdown"]
  --output   output changelog file
  --help     Show help                                                 [boolean]

For more information visit:
https://github.com/frinyvonnick/gitmoji-changelog#readme

Closes #29

[fabienjuif]

Thank you @lhauspie ♥️

You make a good choice I guess.
But the option 2 could work on a CI that publish the package THEN build the docker image.

But let it this way:

• Maybe the --production installation will remove some MB
• We should look at CLI size in a dedicated PR, when gitmoji-changelog will be more stable.

[bpetetot]

👍 Great job!
@lhauspie @fabienjuif @frinyvonnick
Maybe we should also add "Use with Docker" in the README.md file

[fabienjuif]

I agree with @bpetetot and want to add this:
At the end, I was thinking to add a travis line to automatically build and publish this image on @frinyvonnick account

It should be an other PR/Issue

[lhauspie]

I agree too with @bpetetot, but I didn't update the README.md because the docker image was not pushed on the docker hub.

I think, like @fabienjuif, it's part of another issue about "Include the docker image build and publish in travis".

[fabienjuif]

👌

[frinyvonnick]

So I merge it @bpetetot accordingly to previous comments ?

[fabienjuif]

Related issue #64

[frinyvonnick]

Nice work @lhauspie 👍

[lhauspie]

Thank's.
Glad to help 😉