Créer l'Action GitHub "Is First Commit"

Dans cet article je passe en revue une petite GitHub Action que j’ai écrite, Is First Commit. Elle vérifie si le commit actuel est le tout premier d’un dépôt.

Le projet#

Une action commence par un package.json, comme n’importe quel projet Node. Il contient les métadonnées, les dépendances et les scripts.

Pour Is First Commit il ressemble à ça :

  • 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 pour parler à GitHub et appeler son 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"
  }
}

Le fichier action.yaml#

Le fichier action.yaml dit à GitHub comment l’action s’appelle, ce qui entre, ce qui sort et comment l’exécuter :

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'

L’entrée github-token est optionnelle, elle ne sert qu’aux appels authentifiés à l’API.

La logique#

La vérification se fait dans index.js. Le script demande à l’API GitHub les commits du dépôt et regarde s’il n’y en a qu’un. Si c’est le cas, c’est le premier commit.

Voici une version simplifiée :

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();

Ce n’est pas compliqué, et les appels à l’API restent au minimum.

À quoi ça sert#

Savoir que c’est le premier commit permet de lancer des tâches d’initialisation une seule fois, comme préparer certaines ressources.

C’est une petite action, ce qui en fait aussi une bonne première à écrire si vous n’en avez jamais fait.

Commentaires

Il n’y a pas encore de commentaire. Soyez le premier à en écrire un.

Écrire un commentaire