Makefile cleanup #91
Makefile cleanup #91
Conversation
Fix the RPM generation rules to have proper prerequisites. * The 'srpm' and 'rpm' targets will both create the sources.tgz file if needed. * The 'rpm' rule will properly populate the rpmbuild SOURCES directory.
ecs-init/version/version.go is automatically generated, so it should be tracked in git. This change removes it from git and adds its generation as a prerequisite of make rules as appropriate.
Makefile
Outdated
| @@ -42,17 +45,28 @@ build-mock-images: | |||
| docker build -t "test.localhost/amazon/wants-update" -f "scripts/dockerfiles/wants-update.dockerfile" . | |||
| docker build -t "test.localhost/amazon/exit-success" -f "scripts/dockerfiles/exit-success.dockerfile" . | |||
|
|
|||
| sources: | |||
| sources.tgz: ecs-init/version/version.go | |||
| ./scripts/update-version.sh | |||
There was a problem hiding this comment.
This update-version.sh shouldn't be needed if you're generating it as a dependent target.
.gitignore
Outdated
| /SRPMS | ||
| /ecs-init.spec | ||
| /sources.tgz | ||
| ecs-init/version/version.go |
There was a problem hiding this comment.
I must have missed the discussion on moving away from committing the generated version.go, is there a good reason to not commit the file when it changes even if it is generated?
There was a problem hiding this comment.
I'm strongly opposed to adding version.go to .gitignore. I understand that there are concerns with the file changing on every commit; I think a better option would be to remove the need to generate the file and instead use -ldflags to inject the values at link time.
There was a problem hiding this comment.
@jahkeup The generated file contains the git sha. Committing it, by definition, renders it invalid.
There was a problem hiding this comment.
One approach I've seen used for golang based CLI releases use a previous commit (tagged or otherwise) so that the dirty repository is only dirtied by the change to the version.go. However, the approach @samuelkarp mentions is my preference using something along the lines of https://github.com/cogolabs/lgrep/blob/c4efafa3ad84faa51df0bc48bc5c4e702c9b4b8f/Makefile#L4 or https://github.com/coreos/etcd/blob/31e3899663522556e06933297e12fd030efae488/build#L15 where the Version variables are overriden at build time. I would also rather not eliminate this file entirely.
This change updates several of the RPM package Makefile rules to have proper prerequisites such that they can run without having needed to explicitly run the prerequisite rule.
For example, the
srpmrule automatically invokes the sources.tgz rule to generate the required sources.tgz file:Additionally, the autogenerated
ecs-init/version/version.gois removed from git and generated as needed by a make rule.The
cleanrule is updated to correctly clean up artifacts..gitignoreis updated to ensure that generated or ephemeral files are not tracked.