Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented a Dockerfile #592

Merged
merged 3 commits into from Nov 23, 2017
Merged

Implemented a Dockerfile #592

merged 3 commits into from Nov 23, 2017

Conversation

ferrarimarco
Copy link
Contributor

@ferrarimarco ferrarimarco commented Nov 23, 2017

In this pull request I implemented a Dockerfile and added a couple of notes to the README (to refine, asking for help on this).

Relevant issue: #591

Implementation

Base Image

I chose ruby:2.4-alpine3.6 as a base for this Docker image after checking CHANGELOG.md (see #487).
Such base always points to the latest 2.4.x release. We can explicitely point to ruby:2.4.1-alpine3.6 if desired (but then we are creating another bit to update on each Ruby version bump).

I picked up the latest Alpine variant to reduce the size of the resulting image.

GitHub Changelog Generator Installation

The installation is carried out by the following command:

RUN gem install github_changelog_generator

This means that gem will install the current default version. We can extend this to allow the installation of pre-release versions and even by explicitly specify the version to install (this means that the Dockerfile has to be (maybe automatically) modified on each version bump). Let talk about this.

I can also configure Travis CI to build the Docker image on each commit, to test if everything is fine on this side. Let's decide first how to handle the version to install.

Volumes

We declare /usr/local/src/your-app (feel free to find a better name for the directory) as a Docker Volume and then we expect that the user bind mounts his repository root to /usr/local/src/your-app, as we suggest in the README.

README

As stated, I'm asking for help here. Can you please check if the only addition is enough?

@ferrarimarco ferrarimarco changed the title Implemented a Dockerfile. See skywinder/github-changelog-generator#591 Implemented a Dockerfile. See #591 Nov 23, 2017
@ferrarimarco ferrarimarco changed the title Implemented a Dockerfile. See #591 Implemented a Dockerfile Nov 23, 2017
Dockerfile Outdated
@@ -0,0 +1,14 @@
FROM ruby:2.4-alpine3.6

LABEL maintainer "olle.jonsson@gmail.com"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you be the maintainer of this Dockerfile? Care to join?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@olleolleolle
Copy link
Collaborator

olleolleolle commented Nov 23, 2017

Auto-bumping the build version in a script seems like an OK release process.

I use the bump gem, to increase the version number of the gem. That can be used to change the Dockerfile, too, afterwards.

I'm thinking we can wrap this inside a Rake task as a step later.

So, make it an explicit version number.

@ferrarimarco
Copy link
Contributor Author

@olleolleolle done, added the explicit version

@olleolleolle olleolleolle merged commit e87b267 into github-changelog-generator:master Nov 23, 2017
@ferrarimarco ferrarimarco deleted the feature/dockerfile branch November 23, 2017 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants