6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 06:07:56 +00:00
tutor/Makefile

144 lines
4.6 KiB
Makefile
Raw Normal View History

.DEFAULT_GOAL := help
2020-01-10 14:30:09 +00:00
.PHONY: docs
SRC_DIRS = ./tutor ./tests ./bin
BLACK_OPTS = --exclude templates ${SRC_DIRS}
###### Development
2020-01-10 14:30:09 +00:00
docs: ## Build html documentation
$(MAKE) -C docs
compile-requirements: ## Compile requirements files
pip-compile requirements/base.in
pip-compile requirements/dev.in
pip-compile requirements/docs.in
upgrade-requirements: ## Upgrade requirements files
pip-compile --upgrade requirements/base.in
pip-compile --upgrade requirements/dev.in
pip-compile --upgrade requirements/docs.in
2019-06-19 10:14:49 +00:00
package: ## Build a package ready to upload to pypi
python3 setup.py sdist
2017-12-26 00:16:35 +00:00
test: test-lint test-unit test-format test-package ## Run all tests by decreasing order or priority
test-format: ## Run code formatting tests
2019-06-03 10:23:05 +00:00
black --check --diff $(BLACK_OPTS)
test-lint: ## Run code linting tests
pylint --errors-only --ignore=templates ${SRC_DIRS}
test-unit: ## Run unit tests
python3 -m unittest discover tests
test-package: package ## Test that package can be uploaded to pypi
twine check dist/tutor-openedx-$(shell make version).tar.gz
format: ## Format code automatically
2019-06-03 10:23:05 +00:00
black $(BLACK_OPTS)
###### Deployment
bundle: ## Bundle the tutor package in a single "dist/tutor" executable
pyinstaller tutor.spec
dist/tutor:
$(MAKE) bundle
nightly: ## Create a "nightly" release
$(MAKE) tag TAG=nightly
release: ## Create a release tag and push it to origin
2019-07-04 10:01:27 +00:00
$(MAKE) retag release-origin release-overhangio TAG=v$(shell make version)
2019-07-04 10:01:27 +00:00
retag:
2019-02-18 08:57:59 +00:00
@echo "=== Creating tag $(TAG)"
git tag -d $(TAG) || true
git tag $(TAG)
2019-07-04 10:01:27 +00:00
release-origin:
@echo "=== Pushing tag $(TAG) to origin"
git push origin :$(TAG) || true
git push origin $(TAG)
2019-07-04 10:01:27 +00:00
release-overhangio:
@echo "=== Pushing tag $(TAG) to overhangio"
git push overhangio :$(TAG) || true
git push overhangio $(TAG)
###### Continuous integration tasks
2019-02-10 20:02:30 +00:00
ci-info: ## Print info about environment
python3 --version
pip3 --version
2019-10-09 11:38:17 +00:00
ci-install-alpine-requirements: ## Install requirements for a python:alpine image
apk add --no-cache docker gcc libffi-dev libressl-dev musl-dev yaml-dev
2019-10-09 11:38:17 +00:00
ci-install-python-requirements: ## Install requirements
pip3 install --upgrade pip
pip3 install setuptools==44.0.0
python3 setup.py install
2019-02-10 20:02:30 +00:00
pip3 install -r requirements/dev.txt
2019-05-05 09:49:08 +00:00
ci-install-plugins: ci-install-python-requirements ## Install all supported plugins
2019-06-23 20:46:41 +00:00
pip3 install -r requirements/plugins.txt
2019-12-25 00:09:53 +00:00
ci-bundle: bundle ## Create bundle and run basic tests
./dist/tutor --version
./dist/tutor config printroot
yes "" | ./dist/tutor config save --interactive
2019-07-03 14:09:33 +00:00
./dist/tutor config save
./dist/tutor plugins list
2019-12-25 00:09:53 +00:00
./dist/tutor plugins enable discovery ecommerce figures lts minio notes xqueue
./dist/tutor plugins list
2019-12-25 00:09:53 +00:00
./dist/tutor lts --help
2019-02-10 20:02:30 +00:00
./releases/github-release: ## Download github-release binary
2019-12-25 00:09:53 +00:00
mkdir -p releases/
cd releases/ \
&& curl -sSL -o ./github-release.tar.bz2 "https://github.com/aktau/github-release/releases/download/v0.7.2/$(shell uname -s | tr "[:upper:]" "[:lower:]")-amd64-github-release.tar.bz2" \
&& bzip2 -d -f ./github-release.tar.bz2 \
&& tar xf github-release.tar \
&& mv "bin/$(shell uname -s | tr "[:upper:]" "[:lower:]")/amd64/github-release" .
ci-github: ./releases/github-release ## Upload assets to github
sed "s/TUTOR_VERSION/v$(shell make version)/g" docs/_release_description.md > releases/description.md
git log -1 --pretty=format:%b >> releases/description.md
./releases/github-release release \
--user overhangio \
--repo tutor \
--tag "v$(shell make version)" \
--name "v$(shell make version)" \
--description "$$(cat releases/description.md)" || true
./releases/github-release upload \
--user overhangio \
--repo tutor \
--tag "v$(shell make version)" \
--name "tutor-$$(uname -s)_$$(uname -m)" \
--file ./dist/tutor \
--replace
ci-bootstrap-images:
pip install -r requirements/plugins.txt
2019-07-04 09:26:10 +00:00
tutor config save
ci-build-images: ci-bootstrap-images ## Build docker images
2019-02-10 20:02:30 +00:00
tutor images build all
ci-push-images: ci-bootstrap-images ## Push docker images to hub.docker.com
docker login -u "$$DOCKER_USERNAME" -p "$$DOCKER_PASSWORD"
tutor images push all
2019-06-23 20:46:41 +00:00
ci-pypi: ## Push packages to pypi
twine upload --skip-existing dist/tutor-*.tar.gz
2019-02-10 20:02:30 +00:00
###### Additional commands
version: ## Print the current tutor version
@python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutor", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])'
2018-09-29 15:22:55 +00:00
ESCAPE = 
help: ## Print this help
@grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \
| sed 's/######* \(.*\)/\n $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' \
| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'