Life with 🐘 🐳 🐧 💻

Développer une GitHub Action peut être une expérience enrichissante pour plonger dans le monde de l’automatisation. Dans cet article, je vous emmène dans les coulisses de la création de "Is First Commit", une petite mais utile GitHub Action qui vérifie si le commit actuel est le tout premier d’un dépôt.

Mise en place du projet

Chaque GitHub Action commence par un fichier fondamental : package.json. Ce fichier définit les métadonnées de l’action, ses dépendances et ses scripts utiles.

Pour l’action Is First Commit, voici un aperçu rapide :

• Nom : first-commit-action
• Description : Vérifie si le commit actuel est le tout premier du dépôt.
• Script principal : index.js
• Dépendances : @actions/core, @actions/github et axios fournissent les bases pour interagir avec GitHub et effectuer les requêtes API.

{
  "name": "first-commit-action",
  "version": "1.0.0",
  "description": "Check if the current commit is the first ever commit of the project",
  "main": "index.js",
  "keywords": ["github", "action"],
  "author": "Dennis de Best",
  "license": "ISC",
  "scripts": {
    "lint": "eslint .",
    "prepare": "ncc build index.js -o dist --source-map --license licenses.txt",
    "test": "jest",
    "all": "npm run lint && npm run prepare && npm run test"
  },
  "dependencies": {
    "@actions/core": "^1.10.0",
    "@actions/github": "^5.1.1",
    "axios": "^1.5.0"
  }
}

Définir les métadonnées de l’action

Le fichier action.yaml agit comme le plan de votre GitHub Action. Il fournit des informations essentielles telles que son nom, sa description, ses entrées, ses sorties et sa configuration d’exécution.

Voici à quoi cela ressemble pour cette action :

name: 'Is First Commit'
description: 'Check if the current commit is the first-ever commit of the project'
inputs:
  github-token:
    description: 'GitHub token (optional)'
    required: false
outputs:
  isFirstCommit:
    description: 'A boolean indicating if the current commit is the first one'
runs:
  using: 'node16'
  main: 'dist/index.js'

Cette configuration indique à GitHub comment exécuter l’action et quoi attendre en termes d’entrées et de sorties. Le github-token optionnel est utilisé pour effectuer des appels API authentifiés lorsque nécessaire.

Créer la logique

La vraie magie se trouve dans index.js. C’est ici que nous vérifions si le commit actuel est bien le premier du dépôt.

Le script récupère la liste des commits du dépôt via l’API GitHub et vérifie si un seul commit existe. Si c’est le cas, c’est le commit initial.

Voici une version simplifiée de la logique :

const core = require('@actions/core');
const github = require('@actions/github');
const axios = require('axios');

async function isFirstCommit() {
  try {
    const { owner, repo } = github.context.repo;
    const token = core.getInput('github-token');

    const headers = { 'Accept': 'application/vnd.github.v3+json' };
    if (token) {
      headers['Authorization'] = `Bearer ${token}`;
    }

    const url = `https://api.github.com/repos/${owner}/${repo}/commits`;
    const response = await axios.get(url, {
      headers,
      params: { per_page: 2 }
    });

    const commits = response.data;
    const isFirst = commits.length === 1;

    core.setOutput('isFirstCommit', isFirst ? 'true' : 'false');
  } catch (error) {
    core.setFailed(error.message);
  }
}

isFirstCommit();

Cette logique simple garantit que l’action reste efficace et fiable, tout en minimisant les appels à l’API.

Pour conclure

Créer cette GitHub Action a été à la fois amusant et instructif. Cela montre comment de petites automatisations ciblées peuvent améliorer vos workflows CI/CD. En détectant le premier commit d’un dépôt, vous pouvez déclencher conditionnellement des tâches d’initialisation, configurer des ressources ou même célébrer la naissance d’un projet automatiquement 🎉.

Si vous débutez avec GitHub Actions, cet exemple constitue un excellent point de départ pour explorer comment l’automatisation peut simplifier votre processus de développement.

Happy coding !

Dennis de Best