tutor/Makefile

.PHONY: android build
.DEFAULT_GOAL := help

PWD = $$(pwd)
USERID ?= $$(id -u)

build: ## Build all docker images
	cd build/ && make build

config.json: upgrade-to-tutor
	@$(MAKE) -s -C build/ build-configurator 1> /dev/null
	@docker run --rm -it \
		--volume="$(PWD):/openedx/config/" \
		-e USERID=$(USERID) -e SILENT=$(SILENT) \
		regis/openedx-configurator:hawthorn

substitute: config.json
	@docker run --rm -it \
		--volume="$(PWD)/config.json:/openedx/config/config.json" \
		--volume="$(TEMPLATES):/openedx/templates" \
		--volume="$(OUTPUT):/openedx/output" \
		-e USERID=$(USERID) -e SILENT=$(SILENT) $(CONFIGURE_OPTS) \
		regis/openedx-configurator:hawthorn \
		configurator substitute /openedx/templates/ /openedx/output/

singleserver: upgrade-to-tutor ## Configure and run a ready-to-go Open edX platform
	$(MAKE) -C deploy/singleserver all

stop: ## Stop all single server services
	$(MAKE) -C deploy/singleserver stop

android: upgrade-to-tutor ## Configure and build a development Android app
	cd android/ && make all

travis: upgrade-to-tutor
	cd build && make build
	cd deploy/singleserver \
		&& make configure SILENT=1 CONFIGURE_OPTS="-e SETTING_ACTIVATE_NOTES=1 -e SETTING_ACTIVATE_XQUEUE=1" \
		&& make databases \
		&& make assets

upgrade-to-tutor: ## Upgrade from earlier versions of tutor
	@(stat config/config.json > /dev/null 2>&1 && (\
		echo "You are running an older version of Tutor. Now migrating to the latest version" \
		&& echo "Moving config/config.json to ./config.json" && mv config/config.json config.json \
		&& echo "Moving config/ to deploy/env/" && mv config/ deploy/env/ \
		&& ((ls openedx/themes/* > /dev/null 2>&1 && echo "Moving openedx/themes/* to build/openedx/themes/" && mv openedx/themes/* build/openedx/themes/) || true) \
		&& echo "Done migrating to tutor. This command will not be run again."\
	)) || true

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}'
-												Migrate openedx-docker project to Tutor :woman_teacher:

The project gets a new name and some proper documentation. Build/Deploy
are now properly separated.

											
										
										
											2018-12-03 18:59:09 +00:00
+								.PHONY: android build
-												Add a self-documenting Make help

Picked from https://github.com/openfun/fun-platform, which itself picked
it from https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html

Running `make help` or simply `make` now produces a beautiful colored
help.

											
										
										
											2018-09-29 15:08:39 +00:00
+								.DEFAULT_GOAL := help
-												Migrate openedx-docker project to Tutor :woman_teacher:

The project gets a new name and some proper documentation. Build/Deploy
are now properly separated.

											
										
										
											2018-12-03 18:59:09 +00:00
+								PWD = $$(pwd)
-												USER_ID -> USERID for coherence

											
										
										
											2018-04-30 07:01:40 +00:00
+								USERID ?= $$(id -u)
-												Working stack: still some bugs to fix

											
										
										
											2017-12-26 00:16:35 +00:00
-												Migrate openedx-docker project to Tutor :woman_teacher:

The project gets a new name and some proper documentation. Build/Deploy
are now properly separated.

											
										
										
											2018-12-03 18:59:09 +00:00
+								build: ## Build all docker images
 									cd build/ && make build
-												Provide better names for help sections

											
										
										
											2018-09-29 15:22:55 +00:00
-												Improve documentation

											
										
										
											2018-12-26 15:00:47 +00:00
+								config.json: upgrade-to-tutor
-												Migrate openedx-docker project to Tutor :woman_teacher:

The project gets a new name and some proper documentation. Build/Deploy
are now properly separated.

											
										
										
											2018-12-03 18:59:09 +00:00
+									@$(MAKE) -s -C build/ build-configurator 1> /dev/null
 									@docker run --rm -it \
 										--volume="$(PWD):/openedx/config/" \
 										-e USERID=$(USERID) -e SILENT=$(SILENT) \
-												Simplify configurator

Template files are now directly loaded in the configurator container, so
that it is possible to run the configurator container directly, outside
of this project.

											
										
										
											2018-09-15 14:19:35 +00:00
+										regis/openedx-configurator:hawthorn
-												Enable course search and discovery

Also, improved openedx logging, so that logs are not emitted twice.

											
										
										
											2018-09-15 09:55:42 +00:00
-												Simplify env/configure commands

"env" now only generates the environment, and depends only on
config.json, which is run only when necessary. There exists only one
"make configure" command, which force-runs config.json and builds the
env.

											
										
										
											2018-12-25 19:47:41 +00:00
+								substitute: config.json
 									@docker run --rm -it \
 										--volume="$(PWD)/config.json:/openedx/config/config.json" \
 										--volume="$(TEMPLATES):/openedx/templates" \
 										--volume="$(OUTPUT):/openedx/output" \
 										-e USERID=$(USERID) -e SILENT=$(SILENT) $(CONFIGURE_OPTS) \
 										regis/openedx-configurator:hawthorn \
 										configurator substitute /openedx/templates/ /openedx/output/
-												Improve documentation

											
										
										
											2018-12-26 15:00:47 +00:00
+								singleserver: upgrade-to-tutor ## Configure and run a ready-to-go Open edX platform
 									$(MAKE) -C deploy/singleserver all
-												Better naming for db make targets

											
										
										
											2018-09-29 15:33:43 +00:00
-												Improve documentation

											
										
										
											2018-12-26 15:00:47 +00:00
+								stop: ## Stop all single server services
 									$(MAKE) -C deploy/singleserver stop
 								android: upgrade-to-tutor ## Configure and build a development Android app
-												Migrate openedx-docker project to Tutor :woman_teacher:

The project gets a new name and some proper documentation. Build/Deploy
are now properly separated.

											
										
										
											2018-12-03 18:59:09 +00:00
+									cd android/ && make all
-												Make Xqueue an optional feature

Xqueue is no longer run by default. Instead, add the ACTIVATE_XQUEUE
environment variable to add it to the platform.

											
										
										
											2018-08-19 12:40:38 +00:00
-												Improve documentation

											
										
										
											2018-12-26 15:00:47 +00:00
+								travis: upgrade-to-tutor
-												Migrate openedx-docker project to Tutor :woman_teacher:

The project gets a new name and some proper documentation. Build/Deploy
are now properly separated.

											
										
										
											2018-12-03 18:59:09 +00:00
+									cd build && make build
 									cd deploy/singleserver \
 										&& make configure SILENT=1 CONFIGURE_OPTS="-e SETTING_ACTIVATE_NOTES=1 -e SETTING_ACTIVATE_XQUEUE=1" \
 										&& make databases \
 										&& make assets
-												Add xqueue services

Xqueue containers consist of two services: a gunicorn service, that
receives requests from LMS/CMS, and a worker service. I guess the worker
service receives orders from the gunicorn service, through rabbitmq.
(but I'm less than certain about that).

While adding xqueue containers, we refactored the way mysql databases
are created, and how the root password is loaded. Also, we silenced some
options from the configure script.

											
										
										
											2018-06-02 01:29:53 +00:00
-												Improve documentation

											
										
										
											2018-12-26 15:00:47 +00:00
+								upgrade-to-tutor: ## Upgrade from earlier versions of tutor
-												Migrate openedx-docker project to Tutor :woman_teacher:

The project gets a new name and some proper documentation. Build/Deploy
are now properly separated.

											
										
										
											2018-12-03 18:59:09 +00:00
+									@(stat config/config.json > /dev/null 2>&1 && (\
 										echo "You are running an older version of Tutor. Now migrating to the latest version" \
 										&& echo "Moving config/config.json to ./config.json" && mv config/config.json config.json \
 										&& echo "Moving config/ to deploy/env/" && mv config/ deploy/env/ \
 										&& ((ls openedx/themes/* > /dev/null 2>&1 && echo "Moving openedx/themes/* to build/openedx/themes/" && mv openedx/themes/* build/openedx/themes/) || true) \
 										&& echo "Done migrating to tutor. This command will not be run again."\
 									)) || true
-												Provide better names for help sections

											
										
										
											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}'