@sumor/git

جيت

أداة Sumor Cloud.
مستندات إضافية

مكتبة إصدار Git تقوم بتعبئة الإصدار بسهولة وتوليد حزمة محددة مع بيئة معينة.

نسخة NPM تحميلات NPM CI GitHub اختبار GitHub تغطية GitHub فحص GitHub

التثبيت

npm i @sumor/git --save

المتطلبات الأساسية

إصدار Node.JS

يتطلب إصدار Node.JS 18.x أو أعلى

يتطلب إصدار Node.JS ES موديل

نظرًا لأن هذه الحزمة مكتوبة بتشكيلة ES module، الرجاء تغيير الرمز التالي في ملف package.json الخاص بك:

{
  "type": "module"
}

الاستخدام

import git from '@sumor/git'
const config = {
  // git url and credentials
  url: '<git url>', // إلزامي
  token: '<git token>', // إلزامي، إذا لم تتمكن من تقديم اسم المستخدم وكلمة المرور
  username: '<اسم المستخدم من Git>', // إلزامي، إذا لم يتم تقديم رمز
  password: '<كلمة المرور من Git>' // إلزامي، إذا لم يتم تقديم رمز
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // الحصول على الـcommit الحالي

const commit2 = await repository.checkout('<commit الهدف>') // يمكن أن يكون فرعًا أو وسمًا أو commit

// إذا قمت بتثبيت Github Desktop، يمكنك استخدام الأمر التالي لفتحه في Github Desktop
await repository.github()

إنشاء مستودع محلي جديد

عندما تمرر قيمة null كإعداد، سيتم إنشاء مستودع جديد في المسار المحلي.

await git(null, path1)

// الاستخدام لمستودع محلي
const repository = await git({ url: path1 }, path2)