@sumor/git

git

Un outil Sumor Cloud.
Plus de Documentation

Une bibliothèque de version git, permettant de facilement empaqueter une version et de générer un package spécifique avec un environnement.

Version NPM Téléchargements NPM CI GitHub Test GitHub Couverture GitHub Audit GitHub

Installation

npm i @sumor/git --save

Prérequis

Version de Node.JS

Nécessite la version Node.JS 18.x ou supérieure

Module ES de Node.JS requis

Comme ce package est écrit en module ES, veuillez modifier le code suivant dans votre fichier package.json:

{
  "type": "module"
}

Utilisation

import git from '@sumor/git'
const config = {
  // url et informations d'identification git
  url: '<url git>', // obligatoire
  token: '<token git>', // obligatoire, si le nom d'utilisateur et le mot de passe ne sont pas fournis
  username: "<nom d'utilisateur git>", // obligatoire, si le token n'est pas fourni
  password: '<mot de passe git>' // obligatoire, si le token n'est pas fourni
}
const repository = await git(config, chemin)

const commit1 = await repository.currentCommit() // récupérer le commit actuel

const commit2 = await repository.checkout('<commit cible>') // peut être une branche, un tag ou un commit

// si vous avez installé Github Desktop, vous pouvez utiliser la commande ci-dessous pour l'ouvrir dans Github Desktop
await repository.github()

Créer un nouveau dépôt local

Lorsque vous passez null comme config, il créera un nouveau dépôt dans le chemin local.

await git(null, chemin1)

// utilisation pour le dépôt local
const repository = await git({ url: chemin1 }, chemin2)