yakworks/bin

common scripts, templates and helpers for building and develpment

bin

common scripts, templates and helpers for building and develpment

Lost art of the makefile

• https://www.olioapps.com/blog/the-lost-art-of-the-makefile/
• https://3musketeers.io/

12 factor app is the philosophy

• https://12factor.net

Semantic versioning support

semver which is based on this tool provides utility to manipulate semantic version strings from bash scripts.

syntax : semver bump (major|minor|patch|pre-release) <version>

Note: Version must be properly formatted as a semantic version string

Examples:

command	output
./semver bump pre-release 10.0.0-RC.1	10.0.0-RC.2
./semver bump patch 10.0.0	10.0.1
./semver bump minor 10.0.0	10.1.0
./semver bump major 10.0.0	11.0.0

Note: ./semver bump pre-release will work only if the version has pre release part, eg 10.0.0-RC.2

build_functions.sh helpers

command	output	Note
incrementVersion patch 10.0.0	10.0.1	Helper method to increment version. It calls semver bump with given arguments
updateVersionProps 10.0.0-RC.1	updates the version.properties with given version string	it expects version.properties in current directory

Example

source ./build_functions.sh
incrementVersion patch 10.0.0 #Will output 10.0.1
updateVersionProps 10.0.11 #Will update version.properties with version=10.0.11

Make file helpers

Make target	Note
make version	prints the version which will be released.
make update-version	updates version.properties with new version
make git-tag	Tags the current version and pushes to github
make release	it depends on following targets update-version build/docker-build build/docker-deploy git-tag so it will update the version, build docker image, push image to dockerhub and then create a git tag

Makefile.deploy-common-targets must have been included in the main make file of the target project eg. include /PATH-TO/Makefile.deploy-common-targets

Refs

links for using make and docker

• https://amaysim.engineering/the-3-musketeers-how-make-docker-and-compose-enable-us-to-release-many-times-a-day-e92ca816ef17
• https://3musketeers.io/about/#what
• https://www.freecodecamp.org/news/want-to-know-the-easiest-way-to-save-time-use-make-eec453adf7fe/
• https://swcarpentry.github.io/make-novice/02-makefiles/
• https://krzysztofzuraw.com/blog/2016/makefiles-in-python-projects.html
• https://datakurre.pandala.org/2016/04/evolution-of-our-makefile-for-docker.html/
• https://engineering.docker.com/2019/06/containerizing-test-tooling-creating-your-dockerfile-and-makefile/
• https://github.com/marmelab/make-docker-command/blob/master/Makefile
• https://github.com/mvanholsteijn/docker-makefile
• https://itnext.io/docker-makefile-x-ops-sharing-infra-as-code-parts-ea6fa0d22946

versioning example

• https://github.com/mvanholsteijn/docker-makefile

docker makefiles

• https://philpep.org/blog/a-makefile-for-your-dockerfiles
• https://stackoverflow.com/questions/44969605/incrementally-build-docker-image-hierarchy-with-makefile

bin's Issues

automate release process for jars and docker

Story
As a dev and ci I want to have the same automated versioning mechanism and tagging on releases without needing gradle. As a dev I want to be able to do this versioning and tagging for docker images and in python project such as OCI.

The goal of this issue is to bascially duplicate the functionality that is in the shipyak gradle plugin that is based on shipkit. The bash script should follow https://semver.org
The bash script should follow same rules as the gradle-plugin we are using now that is based on shipkit

implement bash script for version update for automate release process for jars and docker

Right now when we deploy rcm to the client the war is created, versioned and released in repo.9ci.com , we tag it github and we can always either recreate it form the tag or just download from the repo.

With new implementation with docker we need similar automatic way of versioning our docker production releases.

take a look at the https://github.com/mvanholsteijn/docker-makefile example, we can do something similar