Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DONE] Add "help" command to makefile #792

Merged
merged 4 commits into from
Apr 3, 2023
Merged

[DONE] Add "help" command to makefile #792

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
343195c
Fixup. Format code with Black
invalid-email-address Mar 23, 2023
0242256
Auto-update configuration files
invalid-email-address Mar 23, 2023
455e131
Add "help" command to makefile
Badatos Mar 29, 2023
6458679
Merge branch 'EsupPortail:develop' into develop
Badatos Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 25 additions & 16 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,73 +4,80 @@
# Lancer via `make $cmd`
# (en remplacant $cmd par une commande ci-dessous)


# Affiche la liste des commandes disponibles
help:
echo "Syntax: [make target] where target is in this list:"
@awk '/^#/{c=substr($$0,3);next}c&&/^[[:alpha:]][[:alnum:]_-]+:/{print substr($$1,1,index($$1,":")),c}1{c=0}' $(MAKEFILE_LIST) | column -s: -t
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C'est beau ! ca faisait longtemps que j'avais pas vu une commande shell de cette taille !

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ha ha elle n'est pas de moi ;) je l'ai vue dans un autre projet et du coup je me suis dit que ce serait bien de la reprendre ;)

Voici le résultat qu'elle affiche :

Esup-Pod-dev3 % make help
echo "Syntax: [make target] where target is in this list:"
Syntax: [make target] where target is in this list:
help            Affiche la liste des commandes disponibles
start           Démarre le serveur de test
starts          Démarre le serveur de test en https auto-signé
install         Première installation de pod (BDD SQLite intégrée)
upgrade         Mise à jour de Pod
createDB        Création des données initiales dans la BDD SQLite intégrée
lang            Mise à jour des fichiers de langue
updatedb        Look for changes to apply in DB
migrate         Apply all changes in DB
tests           Launch all unit tests.
pystyle         Ensure coherence of all code style
statics         Collects all static files inside all apps and put a copy inside the static directory declared in settings.py
createconfigs   Generate configuration docs in .MD format
docker-logs     Display app logs (follow mode)
echo-env        Display environment variables for docker
docker-build    Démarre le serveur de test en recompilant les conteneurs de la stack
docker-start    Démarre le serveur de test
docker-stop     Arrête le serveur de test
docker-reset    Arrête le serveur de test et supprime les fichiers générés


# Démarre le serveur de test
start:
# Démarre le serveur de test
(sleep 15 ; open http://localhost:9090) &
python3 manage.py runserver localhost:9090 --insecure
# --insecure let serve static files even when DEBUG=False

# Démarre le serveur de test en https auto-signé
starts:
# Démarre le serveur de test en https auto-signé
# nécessite les django-extensions
# cf https://timonweb.com/django/https-django-development-server-ssl-certificate/
(sleep 15 ; open https://localhost:8000) &
python3 manage.py runserver_plus --cert-file cert.pem --key-file key.pem

# Première installation de pod (BDD SQLite intégrée)
install:
# Première installation de pod (BDD SQLite intégrée)
npm install -g yarn
cd pod; yarn
make upgrade
make createDB

# Mise à jour de Pod
upgrade:
# Mise à jour de Pod
git pull origin master
python3 -m pip install -r requirements.txt
make updatedb
make migrate
make statics

# Création des données initiales dans la BDD SQLite intégrée
createDB:
# Création des données initiales dans la BDD SQLite intégrée
find . -path "*/migrations/*.py" -not -name "__init__.py" -delete
find . -path "*/migrations/*.pyc" -delete
make updatedb
make migrate
python3 manage.py loaddata pod/video/fixtures/initial_data.json
python3 manage.py loaddata pod/main/fixtures/initial_data.json

# Mise à jour des fichiers de langue
lang:
# Mise à jour des fichiers de langue
echo "Processing python files..."
python3 manage.py makemessages --all -i "opencast-studio/*" -i "pod/custom/settings_local.py"
echo "Processing javascript files..."
django-admin makemessages -d djangojs -l fr -l nl -i "*.min.js" -i "pod/static/*" -i "opencast-studio/*" -i "*/node_modules/*"

# Look for changes to apply in DB
updatedb:
# Look for changes to apply in DB
python3 manage.py makemigrations

# Apply all changes in DB
migrate:
# Apply all changes in DB
python3 manage.py migrate

# Launch all unit tests.
tests:
# Launch all unit tests.
coverage run --source='.' manage.py test --settings=pod.main.test_settings
coverage html

# Ensure coherence of all code style
pystyle:
# Ensure coherence of all code style
flake8

# Collects all static files inside all apps and put a copy inside the static directory declared in settings.py
statics:
cd pod; yarn upgrade
# Collects all static files inside all apps and put a copy inside the static directory declared in settings.py
# --clear Clear the existing files before trying to copy or link the original file.
python3 manage.py collectstatic --clear

# Generate configuration docs in .MD format
createconfigs:
python3 manage.py createconfiguration fr
python3 manage.py createconfiguration en
Expand All @@ -89,15 +96,17 @@ DOCKER_LOGS = docker logs -f
# # Vous devriez obtenir ce message une fois esup-pod lancé
# # $ pod-dev-with-volumes | Superuser created successfully.

docker-logs: ## display app logs (follow mode)
# Display app logs (follow mode)
docker-logs:
@$(DOCKER_LOGS) pod-dev-with-volumes

# Display environment variables for docker
echo-env:
@echo ELASTICSEARCH_TAG=$(ELASTICSEARCH_TAG)
@echo PYTHON_TAG=$(PYTHON_TAG)

# Démarre le serveur de test en recompilant les conteneurs de la stack
docker-build:
# Démarre le serveur de test en recompilant les conteneurs de la stack
# (Attention, il a été constaté que sur un mac, le premier lancement peut prendre plus de 5 minutes.)
# N'oubliez pas de supprimer :
# sudo rm -rf ./pod/log
Expand All @@ -111,19 +120,19 @@ docker-build:
# Vous devriez obtenir ce message une fois esup-pod lancé
# $ pod-dev-with-volumes | Superuser created successfully.

# Démarre le serveur de test
docker-start:
# Démarre le serveur de test en recompilant les conteneurs de la stack
# (Attention, il a été constaté que sur un mac, le premier lancement peut prendre plus de 5 minutes.)
@$(COMPOSE) up
# Vous devriez obtenir ce message une fois esup-pod lancé
# $ pod-dev-with-volumes | Superuser created successfully.

# Arrête le serveur de test
docker-stop:
# Arrête le serveur de test
@$(COMPOSE) down -v

# Arrête le serveur de test et supprime les fichiers générés
docker-reset:
# Arrête le serveur de test
@$(COMPOSE) down -v
# sudo rm -rf ./pod/log
sudo rm -rf ./pod/log
Expand Down