mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
19c0511f57
This will cause `make sdist` to fail on platforms which create hard links of symbolic links as regular files, such as MacOS (Darwin). This prevents accidental creation of an sdist tarball without the necessary symbolic links.
405 lines
13 KiB
Makefile
405 lines
13 KiB
Makefile
# WARN: gmake syntax
|
|
########################################################
|
|
# Makefile for Ansible
|
|
#
|
|
# useful targets:
|
|
# make sdist ---------------- produce a tarball
|
|
# make srpm ----------------- produce a SRPM
|
|
# make rpm ----------------- produce RPMs
|
|
# make deb-src -------------- produce a DEB source
|
|
# make deb ------------------ produce a DEB
|
|
# make docs ----------------- rebuild the manpages (results are checked in)
|
|
# make tests ---------------- run the tests (see https://docs.ansible.com/ansible/devel/dev_guide/testing_units.html for requirements)
|
|
# make pyflakes, make pep8 -- source code checks
|
|
|
|
########################################################
|
|
# variable section
|
|
|
|
NAME = ansible
|
|
OS = $(shell uname -s)
|
|
PREFIX ?= '/usr/local'
|
|
|
|
# This doesn't evaluate until it's called. The -D argument is the
|
|
# directory of the target file ($@), kinda like `dirname`.
|
|
MANPAGES ?= $(patsubst %.rst.in,%,$(wildcard ./docs/man/man1/ansible*.1.rst.in))
|
|
ifneq ($(shell which rst2man 2>/dev/null),)
|
|
ASCII2MAN = rst2man $< $@
|
|
else ifneq ($(shell which rst2man.py 2>/dev/null),)
|
|
ASCII2MAN = rst2man.py $< $@
|
|
else
|
|
ASCII2MAN = @echo "ERROR: rst2man from docutils command is not installed but is required to build $(MANPAGES)" && exit 1
|
|
endif
|
|
GENERATE_CLI = docs/bin/generate_man.py
|
|
|
|
PYTHON=python
|
|
SITELIB = $(shell $(PYTHON) -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")
|
|
|
|
# fetch version from project release.py as single source-of-truth
|
|
VERSION := $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --raw || echo error)
|
|
ifeq ($(findstring error,$(VERSION)), error)
|
|
$(error "version_helper failed")
|
|
endif
|
|
|
|
MAJOR_VERSION := $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --majorversion)
|
|
CODENAME := $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --codename)
|
|
|
|
# if a specific release was not requested, set to 1 (RPMs have "fancier" logic for this further down)
|
|
RELEASE ?= 1
|
|
|
|
# Get the branch information from git
|
|
ifneq ($(shell which git),)
|
|
GIT_DATE := $(shell git log -n 1 --format="%ai")
|
|
GIT_HASH := $(shell git log -n 1 --format="%h")
|
|
GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD | sed 's/[-_.\/]//g')
|
|
GITINFO = .$(GIT_HASH).$(GIT_BRANCH)
|
|
else
|
|
GITINFO = ""
|
|
endif
|
|
|
|
ifeq ($(shell echo $(OS) | egrep -c 'Darwin|FreeBSD|OpenBSD|DragonFly'),1)
|
|
DATE := $(shell date -j -r $(shell git log -n 1 --format="%at") +%Y%m%d%H%M)
|
|
CPUS ?= $(shell sysctl hw.ncpu|awk '{print $$2}')
|
|
else
|
|
DATE := $(shell date --utc --date="$(GIT_DATE)" +%Y%m%d%H%M)
|
|
CPUS ?= $(shell nproc)
|
|
endif
|
|
|
|
# DEB build parameters
|
|
DEBUILD_BIN ?= debuild
|
|
DEBUILD_OPTS = --source-option="-I"
|
|
DPUT_BIN ?= dput
|
|
DPUT_OPTS ?=
|
|
DEB_DATE := $(shell LC_TIME=C date +"%a, %d %b %Y %T %z")
|
|
DEB_VERSION ?= $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --debversion)
|
|
ifeq ($(OFFICIAL),yes)
|
|
DEB_RELEASE ?= $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --debrelease)ppa
|
|
# Sign OFFICIAL builds using 'DEBSIGN_KEYID'
|
|
# DEBSIGN_KEYID is required when signing
|
|
ifneq ($(DEBSIGN_KEYID),)
|
|
DEBUILD_OPTS += -k$(DEBSIGN_KEYID)
|
|
endif
|
|
else
|
|
DEB_RELEASE ?= 100.git$(DATE)$(GITINFO)
|
|
# Do not sign unofficial builds
|
|
DEBUILD_OPTS += -uc -us
|
|
DPUT_OPTS += -u
|
|
endif
|
|
DEBUILD = $(DEBUILD_BIN) $(DEBUILD_OPTS)
|
|
DEB_PPA ?= ppa
|
|
# Choose the desired Ubuntu release: lucid precise saucy trusty
|
|
DEB_DIST ?= unstable
|
|
|
|
# pbuilder parameters
|
|
PBUILDER_ARCH ?= amd64
|
|
PBUILDER_CACHE_DIR = /var/cache/pbuilder
|
|
PBUILDER_BIN ?= pbuilder
|
|
PBUILDER_OPTS ?= --debootstrapopts --variant=buildd --architecture $(PBUILDER_ARCH) --debbuildopts -b
|
|
|
|
# RPM build parameters
|
|
RPMSPECDIR= packaging/rpm
|
|
RPMSPEC = $(RPMSPECDIR)/ansible.spec
|
|
RPMDIST = $(shell rpm --eval '%{?dist}')
|
|
|
|
ifneq ($(OFFICIAL),yes)
|
|
RPMRELEASE = 100.git$(DATE)$(GITINFO)
|
|
endif
|
|
ifeq ($(PUBLISH),nightly)
|
|
# https://fedoraproject.org/wiki/Packaging:Versioning#Snapshots
|
|
RPMRELEASE = $(RELEASE).$(DATE)git.$(GIT_HASH)
|
|
endif
|
|
|
|
RPMVERSION ?= $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --baseversion)
|
|
RPMRELEASE ?= $(shell $(PYTHON) packaging/release/versionhelper/version_helper.py --rpmrelease)
|
|
RPMNVR = "$(NAME)-$(RPMVERSION)-$(RPMRELEASE)$(RPMDIST)$(REPOTAG)"
|
|
|
|
# MOCK build parameters
|
|
MOCK_BIN ?= mock
|
|
MOCK_CFG ?=
|
|
|
|
# dynamically add repotag define only if specified
|
|
ifneq ($(REPOTAG),)
|
|
EXTRA_RPM_DEFINES += --define "repotag $(REPOTAG)"
|
|
endif
|
|
|
|
# ansible-test parameters
|
|
ANSIBLE_TEST ?= bin/ansible-test
|
|
TEST_FLAGS ?=
|
|
|
|
# ansible-test units parameters (make test / make test-py3)
|
|
PYTHON_VERSION ?= $(shell python2 -c 'import sys; print("%s.%s" % sys.version_info[:2])')
|
|
PYTHON3_VERSION ?= $(shell python3 -c 'import sys; print("%s.%s" % sys.version_info[:2])')
|
|
|
|
# ansible-test integration parameters (make integration)
|
|
IMAGE ?= centos7
|
|
TARGET ?=
|
|
|
|
########################################################
|
|
|
|
.PHONY: all
|
|
all: clean python
|
|
|
|
.PHONY: tests
|
|
tests:
|
|
$(ANSIBLE_TEST) units -v --python $(PYTHON_VERSION) $(TEST_FLAGS)
|
|
|
|
.PHONY: tests-py3
|
|
tests-py3:
|
|
$(ANSIBLE_TEST) units -v --python $(PYTHON3_VERSION) $(TEST_FLAGS)
|
|
|
|
.PHONY: tests-nonet
|
|
tests-nonet:
|
|
$(ANSIBLE_TEST) units -v --python $(PYTHON_VERSION) $(TEST_FLAGS) --exclude test/units/modules/network/
|
|
|
|
.PHONY: integration
|
|
integration:
|
|
$(ANSIBLE_TEST) integration -v --docker $(IMAGE) $(TARGET) $(TEST_FLAGS)
|
|
|
|
.PHONY: authors
|
|
authors:
|
|
sh hacking/authors.sh
|
|
|
|
# Regenerate %.1.rst if %.1.rst.in has been modified more
|
|
# recently than %.1.rst.
|
|
%.1.rst: %.1.rst.in
|
|
sed "s/%VERSION%/$(VERSION)/" $< > $@
|
|
rm $<
|
|
|
|
# Regenerate %.1 if %.1.rst or release.py has been modified more
|
|
# recently than %.1. (Implicitly runs the %.1.rst recipe)
|
|
%.1: %.1.rst lib/ansible/release.py
|
|
$(ASCII2MAN)
|
|
|
|
.PHONY: loc
|
|
loc:
|
|
sloccount lib library bin
|
|
|
|
.PHONY: pep8
|
|
pep8:
|
|
$(ANSIBLE_TEST) sanity --test pep8 --python $(PYTHON_VERSION) $(TEST_FLAGS)
|
|
|
|
.PHONY: pyflakes
|
|
pyflakes:
|
|
pyflakes lib/ansible/*.py lib/ansible/*/*.py bin/*
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
@echo "Cleaning up distutils stuff"
|
|
rm -rf build
|
|
rm -rf dist
|
|
rm -rf lib/ansible.egg-info/
|
|
@echo "Cleaning up byte compiled python stuff"
|
|
find . -type f -regex ".*\.py[co]$$" -delete
|
|
find . -type d -name "__pycache__" -delete
|
|
@echo "Cleaning up editor backup files"
|
|
find . -type f -not -path ./test/units/inventory_test_data/group_vars/noparse/all.yml~ \( -name "*~" -or -name "#*" \) -delete
|
|
find . -type f \( -name "*.swp" \) -delete
|
|
@echo "Cleaning up manpage stuff"
|
|
find ./docs/man -type f -name "*.xml" -delete
|
|
find ./docs/man -type f -name "*.rst" -delete
|
|
find ./docs/man/man3 -type f -name "*.3" -delete
|
|
rm -f ./docs/man/man1/*
|
|
@echo "Cleaning up output from test runs"
|
|
rm -rf test/test_data
|
|
rm -rf shippable/
|
|
rm -rf logs/
|
|
rm -rf .cache/
|
|
rm -f test/units/.coverage*
|
|
rm -rf test/results/*/*
|
|
find test/ -type f -name '*.retry' -delete
|
|
@echo "Cleaning up RPM building stuff"
|
|
rm -rf MANIFEST rpm-build
|
|
@echo "Cleaning up Debian building stuff"
|
|
rm -rf debian
|
|
rm -rf deb-build
|
|
rm -rf docs/json
|
|
rm -rf docs/js
|
|
@echo "Cleaning up authors file"
|
|
rm -f AUTHORS.TXT
|
|
@echo "Cleaning up docsite"
|
|
$(MAKE) -C docs/docsite clean
|
|
$(MAKE) -C docs/api clean
|
|
|
|
.PHONY: python
|
|
python:
|
|
$(PYTHON) setup.py build
|
|
|
|
.PHONY: install
|
|
install:
|
|
$(PYTHON) setup.py install
|
|
|
|
install_manpages:
|
|
gzip -9 $(wildcard ./docs/man/man1/ansible*.1)
|
|
cp $(wildcard ./docs/man/man1/ansible*.1.gz) $(PREFIX)/man/man1/
|
|
|
|
.PHONY: sdist_check
|
|
sdist_check:
|
|
$(PYTHON) packaging/sdist/check-link-behavior.py
|
|
|
|
.PHONY: sdist
|
|
sdist: sdist_check clean docs
|
|
$(PYTHON) setup.py sdist
|
|
|
|
.PHONY: sdist_upload
|
|
sdist_upload: clean docs
|
|
$(PYTHON) setup.py sdist upload 2>&1 |tee upload.log
|
|
|
|
.PHONY: changelog
|
|
changelog:
|
|
packaging/release/changelogs/changelog.py release -vv && packaging/release/changelogs/changelog.py generate -vv
|
|
|
|
.PHONY: rpmcommon
|
|
rpmcommon: sdist
|
|
@mkdir -p rpm-build
|
|
@cp dist/*.gz rpm-build/
|
|
@cp $(RPMSPEC) rpm-build/$(NAME).spec
|
|
|
|
.PHONY: mock-srpm
|
|
mock-srpm: /etc/mock/$(MOCK_CFG).cfg rpmcommon
|
|
$(MOCK_BIN) -r $(MOCK_CFG) $(MOCK_ARGS) --resultdir rpm-build/ --bootstrap-chroot --old-chroot --buildsrpm --spec rpm-build/$(NAME).spec --sources rpm-build/ \
|
|
--define "rpmversion $(RPMVERSION)" \
|
|
--define "upstream_version $(VERSION)" \
|
|
--define "rpmrelease $(RPMRELEASE)" \
|
|
$(EXTRA_RPM_DEFINES)
|
|
@echo "#############################################"
|
|
@echo "Ansible SRPM is built:"
|
|
@echo rpm-build/*.src.rpm
|
|
@echo "#############################################"
|
|
|
|
.PHONY: mock-rpm
|
|
mock-rpm: /etc/mock/$(MOCK_CFG).cfg mock-srpm
|
|
$(MOCK_BIN) -r $(MOCK_CFG) $(MOCK_ARGS) --resultdir rpm-build/ --bootstrap-chroot --old-chroot --rebuild rpm-build/$(NAME)-*.src.rpm \
|
|
--define "rpmversion $(RPMVERSION)" \
|
|
--define "upstream_version $(VERSION)" \
|
|
--define "rpmrelease $(RPMRELEASE)" \
|
|
$(EXTRA_RPM_DEFINES)
|
|
@echo "#############################################"
|
|
@echo "Ansible RPM is built:"
|
|
@echo rpm-build/*.noarch.rpm
|
|
@echo "#############################################"
|
|
|
|
.PHONY: srpm
|
|
srpm: rpmcommon
|
|
@rpmbuild --define "_topdir %(pwd)/rpm-build" \
|
|
--define "_builddir %{_topdir}" \
|
|
--define "_rpmdir %{_topdir}" \
|
|
--define "_srcrpmdir %{_topdir}" \
|
|
--define "_specdir $(RPMSPECDIR)" \
|
|
--define "_sourcedir %{_topdir}" \
|
|
--define "upstream_version $(VERSION)" \
|
|
--define "rpmversion $(RPMVERSION)" \
|
|
--define "rpmrelease $(RPMRELEASE)" \
|
|
$(EXTRA_RPM_DEFINES) \
|
|
-bs rpm-build/$(NAME).spec
|
|
@rm -f rpm-build/$(NAME).spec
|
|
@echo "#############################################"
|
|
@echo "Ansible SRPM is built:"
|
|
@echo " rpm-build/$(RPMNVR).src.rpm"
|
|
@echo "#############################################"
|
|
|
|
.PHONY: rpm
|
|
rpm: rpmcommon
|
|
@rpmbuild --define "_topdir %(pwd)/rpm-build" \
|
|
--define "_builddir %{_topdir}" \
|
|
--define "_rpmdir %{_topdir}" \
|
|
--define "_srcrpmdir %{_topdir}" \
|
|
--define "_specdir $(RPMSPECDIR)" \
|
|
--define "_sourcedir %{_topdir}" \
|
|
--define "_rpmfilename $(RPMNVR).%%{ARCH}.rpm" \
|
|
--define "__python `which $(PYTHON)`" \
|
|
--define "upstream_version $(VERSION)" \
|
|
--define "rpmversion $(RPMVERSION)" \
|
|
--define "rpmrelease $(RPMRELEASE)" \
|
|
$(EXTRA_RPM_DEFINES) \
|
|
-ba rpm-build/$(NAME).spec
|
|
@rm -f rpm-build/$(NAME).spec
|
|
@echo "#############################################"
|
|
@echo "Ansible RPM is built:"
|
|
@echo " rpm-build/$(RPMNVR).noarch.rpm"
|
|
@echo "#############################################"
|
|
|
|
.PHONY: debian
|
|
debian: sdist
|
|
@for DIST in $(DEB_DIST) ; do \
|
|
mkdir -p deb-build/$${DIST} ; \
|
|
tar -C deb-build/$${DIST} -xvf dist/$(NAME)-$(VERSION).tar.gz ; \
|
|
cp -a packaging/debian deb-build/$${DIST}/$(NAME)-$(VERSION)/ ; \
|
|
sed -ie "s|%VERSION%|$(DEB_VERSION)|g;s|%RELEASE%|$(DEB_RELEASE)|;s|%DIST%|$${DIST}|g;s|%DATE%|$(DEB_DATE)|g" deb-build/$${DIST}/$(NAME)-$(VERSION)/debian/changelog ; \
|
|
done
|
|
|
|
.PHONY: deb
|
|
deb: deb-src
|
|
@for DIST in $(DEB_DIST) ; do \
|
|
PBUILDER_OPTS="$(PBUILDER_OPTS) --distribution $${DIST} --basetgz $(PBUILDER_CACHE_DIR)/$${DIST}-$(PBUILDER_ARCH)-base.tgz --buildresult $(CURDIR)/deb-build/$${DIST}" ; \
|
|
$(PBUILDER_BIN) create $${PBUILDER_OPTS} --othermirror "deb http://archive.ubuntu.com/ubuntu $${DIST} universe" ; \
|
|
$(PBUILDER_BIN) update $${PBUILDER_OPTS} ; \
|
|
$(PBUILDER_BIN) build $${PBUILDER_OPTS} deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}.dsc ; \
|
|
done
|
|
@echo "#############################################"
|
|
@echo "Ansible DEB artifacts:"
|
|
@for DIST in $(DEB_DIST) ; do \
|
|
echo deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_amd64.changes ; \
|
|
done
|
|
@echo "#############################################"
|
|
|
|
# Build package outside of pbuilder, with locally installed dependencies.
|
|
# Install BuildRequires as noted in packaging/debian/control.
|
|
.PHONY: local_deb
|
|
local_deb: debian
|
|
@for DIST in $(DEB_DIST) ; do \
|
|
(cd deb-build/$${DIST}/$(NAME)-$(VERSION)/ && $(DEBUILD) -b) ; \
|
|
done
|
|
@echo "#############################################"
|
|
@echo "Ansible DEB artifacts:"
|
|
@for DIST in $(DEB_DIST) ; do \
|
|
echo deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_amd64.changes ; \
|
|
done
|
|
@echo "#############################################"
|
|
|
|
.PHONY: deb-src
|
|
deb-src: debian
|
|
@for DIST in $(DEB_DIST) ; do \
|
|
(cd deb-build/$${DIST}/$(NAME)-$(VERSION)/ && $(DEBUILD) -S) ; \
|
|
done
|
|
@echo "#############################################"
|
|
@echo "Ansible DEB artifacts:"
|
|
@for DIST in $(DEB_DIST) ; do \
|
|
echo deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_source.changes ; \
|
|
done
|
|
@echo "#############################################"
|
|
|
|
.PHONY: deb-upload
|
|
deb-upload: deb
|
|
@for DIST in $(DEB_DIST) ; do \
|
|
$(DPUT_BIN) $(DPUT_OPTS) $(DEB_PPA) deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_amd64.changes ; \
|
|
done
|
|
|
|
.PHONY: deb-src-upload
|
|
deb-src-upload: deb-src
|
|
@for DIST in $(DEB_DIST) ; do \
|
|
$(DPUT_BIN) $(DPUT_OPTS) $(DEB_PPA) deb-build/$${DIST}/$(NAME)_$(DEB_VERSION)-$(DEB_RELEASE)~$${DIST}_source.changes ; \
|
|
done
|
|
|
|
.PHONY: epub
|
|
epub:
|
|
(cd docs/docsite/; CPUS=$(CPUS) $(MAKE) epub)
|
|
|
|
# for arch or gentoo, read instructions in the appropriate 'packaging' subdirectory directory
|
|
.PHONY: webdocs
|
|
webdocs:
|
|
(cd docs/docsite/; CPUS=$(CPUS) $(MAKE) docs)
|
|
|
|
.PHONY: generate_rst
|
|
generate_rst: lib/ansible/cli/*.py
|
|
mkdir -p ./docs/man/man1/ ; \
|
|
PYTHONPATH=./lib $(GENERATE_CLI) --template-file=docs/templates/man.j2 --output-dir=docs/man/man1/ --output-format man lib/ansible/cli/*.py
|
|
|
|
|
|
docs: generate_rst
|
|
$(MAKE) $(MANPAGES)
|
|
|
|
.PHONY: alldocs
|
|
alldocs: docs webdocs
|
|
|
|
version:
|
|
@echo $(VERSION)
|
|
|