@sumor/git

git

Ein Sumor Cloud Tool.
Mehr Dokumentation

Eine git-Version-Bibliothek, die Versionsierung einfach verpackt und spezifische Pakete mit Umgebungsvariablen generiert.

NPM Version NPM Downloads GitHub CI GitHub Test GitHub Coverage GitHub Audit

Installation

npm i @sumor/git --save

Voraussetzungen

Node.JS Version

Erfordert Node.JS Version 18.x oder höher

Erforderliches Node.JS ES-Modul

Da dieses Paket in einem ES-Modul geschrieben ist, ändern Sie bitte den folgenden Code in Ihrer package.json-Datei:

{
  "type": "module"
}

Verwendung

import git from '@sumor/git'
const config = {
  // git-URL und Anmeldeinformationen
  url: '<git url>', // erforderlich
  token: '<git token>', // erforderlich, falls Benutzername und Passwort nicht angegeben sind
  username: '<git Benutzername>', // erforderlich, falls Token nicht angegeben ist
  password: '<git Passwort>' // erforderlich, falls Token nicht angegeben ist
}
const repository = await git(config, Pfad)

const commit1 = await repository.currentCommit() // aktuelle Commit abrufen

const commit2 = await repository.checkout('<Ziel-Commit>') // kann ein Branch, ein Tag oder ein Commit sein

// Wenn Sie Github Desktop installiert haben, können Sie den folgenden Befehl verwenden, um ihn in Github Desktop zu öffnen
await repository.github()

Neues lokales Repository erstellen

Wenn Sie null als Konfiguration übergeben, wird ein neues Repository im lokalen Pfad erstellt.

await git(null, Pfad1)

// Verwendung für lokales Repository
const repository = await git({ url: Pfad1 }, Pfad2)