Makefile

all: gengetoptions

help: ## display this help message
	@echo "Please use \`make <target>' where <target> is one of"
	@awk -F ':.*?## ' '/^[a-zA-Z]/ && NF==2 {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort

# requires getoptions to be installed
# installing getoptions locally: https://github.com/ko1nksm/getoptions/#installation
gengetoptions: ## use getoptions to generate argument parsing
	gengetoptions embed --overwrite atlas

# requires shellspec to be installed
# installing shellspec locally: https://github.com/shellspec/shellspec/#installation
# note: the CI uses the latest stable version available in brew: `brew tap shellspec/shellspec`, `brew install shellspec`

unit_tests: ## automated testing using shellspec: fast unit tests without external dependency
	shellspec $(shell find spec/ -type f ! -name pull_performance_spec.sh ! -name spec_helper.sh ! -name integration_spec.sh)

performance_tests:  ## automated testing using shellspec: performance integration tests pulling from GitHub.com/openedx
        # This is a slow test that takes a minute or two to run and intended to measure performance
	shellspec spec/pull_performance_spec.sh

integration_tests: ## automated testing using shellspec: faster `git` integration tests with external dependency
	# This test run in few seconds and intended to test `git` integration
	shellspec spec/integration_spec.sh

test: ## automated testing using shellspec: run all tests
	shellspec

atlas_help_to_readme: gengetoptions ## Updates the `atlas --help` section of the README.rst file
	python3 scripts/atlas_help_to_readme.py