Pourquoi je suis passé de Makefile à Taskfile

Photo de Kelly Sikkema sur Unsplash

Introduction

Les projets logiciels impliquent plusieurs phases, notamment la création, les tests et le déploiement du code.
Par exemple, la compilation du code source Go génère un exécutable, tandis que les frameworks frontaux se compilent en fichiers HTML, CSS et JavaScript.
Les tests sont cruciaux avant de fusionner les modifications ou de publier de nouvelles versions. Les scripts de déploiement expédient souvent les logiciels en production.
Chaque phase nécessite différents outils, généralement des utilitaires de ligne de commande avec divers indicateurs et paramètres.
Les outils d'automatisation simplifient ces processus, améliorant ainsi l'efficacité des flux de travail quotidiens.

Makefile

Les Makefiles sont des outils puissants qui automatisent les flux de travail des projets logiciels. Initialement développés pour les programmes C, ils prennent désormais en charge diverses tâches telles que la génération de sites Web et le traitement de données.

Un Makefile contient des directives permettant à l'utilitaire make de créer ou de maintenir des programmes et des fichiers. Il définit les tâches et leurs dépendances, garantissant des builds efficaces et reproductibles.

Je ne plongerai pas dans les Makefiles dans cet article de blog car je suppose que le lecteur est familier avec le concept. Sinon, il existe de nombreuses informations sur Internet (comme ce tutoriel par exemple ou sa page wikipedia).

Avantages de Makefile :

• Intégré à l'utilitaire make, disponible sur la plupart des systèmes Linux/MacOS.
• Un outil bien établi avec près de 50 ans d'histoire.

Ce sont les principaux avantages que je pense que Makefile présente. Cependant, les Makefiles ont des limites, notamment leur syntaxe, qui peut s'avérer lourde pour des tâches complexes.

Pourquoi j'ai changé

Dans l'un de mes projets, j'ai utilisé un Makefile pour des tâches telles que l'exécution de services frontend/backend et les migrations de bases de données. Voici un exemple de tâche de migration :

migrate-up:
    GOOSE_DRIVER=postgres GOOSE_DBSTRING="user=app host=localhost port=5432 dbname=my-app sslmode=disable user=app" \
    goose -dir database/migrations up

Je voulais charger des variables d'environnement à partir d'un fichier .env par défaut mais autoriser les remplacements avec ENV_FILE=.env.production. Après avoir lutté avec la syntaxe Makefile et les solutions qui ne fonctionnaient pas, j'ai cherché des alternatives.

Présentation du fichier de tâches

Taskfile est un exécuteur de tâches basé sur Go utilisant la syntaxe YAML pour définir des tâches. Il simplifie les flux de travail des projets en automatisant les tâches répétitives telles que la création, les tests et le déploiement de code.

Avantages de Taskfile :

• Syntaxe YAML lisible : Plus facile à comprendre que les Makefiles.
• Single Binary : Aucune dépendance au-delà du runtime Go.
• Support multiplateforme : Fonctionne sous Linux, macOS et Windows.

Voici comment j'ai résolu mon problème à l'aide de Taskfile :

version: '3'
dotenv:
  - '.env'

tasks:
  migrate-up:
    cmds:
      - goose -dir database/migrations up

  migrate-up-prod:
    dotenv:
      - .env.production
    cmds:
      - echo executing DB migration on PRODUCTION ..
      - sleep 2 # allow time to cancel
      - goose -dir database/migrations up

L'API intuitive de Taskfile m'a permis de mettre en place rapidement une solution à la fois fonctionnelle et lisible.

Résumé

Choisir le bon outil peut avoir un impact significatif sur la productivité. Alors que Makefile remplissait initialement son objectif, Taskfile offrait une solution plus élégante pour mes besoins. La transition a pris moins de 30 minutes et a considérablement simplifié mon processus de construction.

Si vous recherchez un outil de création facile à utiliser, pensez à essayer Taskfile.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!