Skip to content

Add Makefile #54

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

Merged
merged 2 commits into from
Dec 17, 2015
Merged

Add Makefile #54

merged 2 commits into from
Dec 17, 2015

Conversation

wfleming
Copy link
Contributor

This could be used almost without changes in most of our engines: just change the value of IMAGE_NAME.


IMAGE_NAME=codeclimate/codeclimate-duplication

all: image test
Copy link
Contributor

Choose a reason for hiding this comment

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

Why would I make all when make test is more intention-revealing and has the same result?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a holdover from the one I wrote for builder, with the idea being that just typing make would build an image & also run tests to confirm goodness. You can, of course, run make test explicitly.

I'm fine with removing it & saying the default task should simply be building the image. I'll update builder as well if that's preferred, since whichever way we do it should be consistent.

Actually, I'll go ahead and remove it in both places: earlier Makefiles (app, toolbox) don't do this.

@pbrisbin
Copy link
Contributor

FYI: I'm being nit-heavy here just because I can see this pattern spreading to other engines so it's worth getting right and pinning down style IMO.

@wfleming
Copy link
Contributor Author

Nits are good! I do expect whatever we do here to become the template for other engines, so it's worth sweating the details now so we're happy with it.


all: image test

image:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure I want to keep this task name: as we work with more open source tools as "first party" engines, it'll become more likely those other projects will already have makefiles, so I think "image" might be too generic. I'm wondering if we should standardize on something more explicit that we can expect to use without issue everywhere. Maybe "codeclimate_engine"? Thoughts on this @pbrisbin?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm. It's worth questioning, but I'm not sure I share your concern:

  • An existing project with an existing Makefile is unlikely to be using image, IMHO. While it is generic, I've never seen make image in the wild
  • The intent of this target is (to me) not specifically to "make a codeclimate engine", but to build a docker image named IMAGE_NAME -- make image seems very apt

For those reasons, I'd be OK going with this for now. Could be worth sleeping on it though.

@wfleming
Copy link
Contributor Author

👀 @codeclimate/review

@pbrisbin
Copy link
Contributor

LGTM -- so sleek!

wfleming added a commit that referenced this pull request Dec 17, 2015
@wfleming wfleming merged commit df7ec7e into master Dec 17, 2015
@wfleming wfleming deleted the will/makefile branch December 17, 2015 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants