Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
francois2metz committed Dec 8, 2023
1 parent 5d812c9 commit 86c6bcd
Showing 1 changed file with 3 additions and 20 deletions.
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,9 @@

Ce projet a pour but de suivre nos retards sur les mises à jour de dépendances pour nos projets Node.js via la métrique [libyear][].

## Installation
Il utilise [dependency-drift-tracker][].

```bash
npm ci
```

## Utilisation

Tout d'abord, il faut remplir le fichier `repositories.txt` avec les urls des repositories à suivre.
Dans le cas d'un monorepo, vous pouvez suffixer l'url par `#path` pour indiquer le chemin vers le `package.json` à suivre.

Ensuite, il faut lancer le script `bin/main.mjs` :

```bash
node bin/main.mjs
```

Nous avons fait le choix, de lancer le script toutes les 24h avec un cron dans une GitHub Action
et qui commit les nouveaux résultats.

Enfin, la page `index.html` permet de visualiser les résultats.
La page de suivi: https://1024pix.github.io/dependency-drift-tracker/

[libyear]: https://libyear.com/
[dependency-drift-tracker]: https://github.com/dependency-Drift-Tracker/dependency-drift-tracker

0 comments on commit 86c6bcd

Please sign in to comment.