Skip to content

Latest commit

 

History

History
103 lines (66 loc) · 3 KB

README.md

File metadata and controls

103 lines (66 loc) · 3 KB
Raw

makefiles v0.2.0

A collection of reusable makefiles and tasks designed to make managing your python and docker projects easier.

Installation

Add a main Makefile in your working directory and download the individual files you need as follows:

install: Makefile.semver.mk Makefile.venv.mk

Makefile.semver.mk Makefile.venv.mk:
	wget https://raw.githubusercontent.com/g3w-suite/makefiles/master/$@

include Makefile.semver.mk
include Makefile.venv.mk

After that, use the make command to finalize the installation of those files:

make install

NB on Microsoft you'll need to open a Windows Subsystem for Linux terminal (bash shell) before you can run those commands

Configuration

Update your .gitignore to exclude from version control all the Makefiles installed:

# /Makefile.*.mk

/Makefile.semver.mk
/Makefile.venv.mk

Update your download URL to always get a specific version of a Makefile:

# unstable branch (master)
wget https://raw.githubusercontent.com/g3w-suite/makefiles/master/Makefile.semver.mk

# tagged release (v1.0.0)
wget https://raw.githubusercontent.com/g3w-suite/makefiles/v1.0.0/Makefile.semver.mk

# untagged commit (file permalink)
wget https://raw.githubusercontent.com/g3w-suite/makefiles/71aea4e60b7d4c05e9e7357e0f94eaf82af70a21/Makefile.semver.mk

# API SCHEME:
# wget https://raw.githubusercontent.com/:org/:repo/:branch/:path

Consider to edit your install task as follows in order to keep all Makefile versions consistent:

INCLUDE_MAKEFILES_RELEASE = v0.1.1
INCLUDE_MAKEFILES =         Makefile.semver.mk Makefile.venv.mk

install: $(INCLUDE_MAKEFILES)

$(INCLUDE_MAKEFILES):
	wget https://raw.githubusercontent.com/g3w-suite/makefiles/$(INCLUDE_MAKEFILES_RELEASE)/$@
$(foreach i, ${INCLUDE_MAKEFILES}, $(eval include $i))

clean:
	rm $(INCLUDE_MAKEFILES)

For more info: getting permanent links to files

Publish a new release

Create a new git tag that is appropriate for the version you intend to publish, eg:

make version v=1.1.0
make push-tags

Refer to Makefile.semver.mk file for a complete list of available tasks.

Related resources

Repositories from which to get inspiration:

Quick Makefile reference:

Additional configuration for Microsoft Windows users:

License: MPL-2