وقائع

وقائع

منشئ سجل تغييرات سريع يقوم بمصادر التغييرات من العلاقات العامة والمشكلات في GitHub، ويتم تنظيمها حسب التصنيفات.

قم بإنشاء سجل التغيير من إصدار GitHib الأخير حتى علامة/التزام git HEAD الحالي لـ git repo في الدليل الحالي:

 وقائع

قم بإنشاء سجل التغيير مع جميع التغييرات من الإصدار 0.16.0 حتى علامة/التزام git HEAD الحالي لـ git repo في الدليل الحالي:

 وقائع --منذ العلامة v0.16.0

قم بإنشاء سجل التغيير بين علامتين محددتين للريبو في المسار المحدد

 Chronicle - منذ العلامة v0.16.0 - حتى العلامة v0.18.0 ./path/to/git/repo

قم بإنشاء سجل التغيير وتخمين إصدار الإصدار من مجموعة التغييرات في سجل التغيير

 وقائع -ن

ما عليك سوى تخمين إصدار الإصدار التالي بناءً على مجموعة التغييرات (لا تقم بإنشاء سجل التغيير)

 وقائع الإصدار التالي

تثبيت

 حليقة -sSfL https://raw.githubusercontent.com/anchore/chronicle/main/install.sh | sh -s -- -b /usr/local/bin

...أو يمكنك تحديد إصدار الإصدار ودليل الوجهة للتثبيت:

curl -sSfL https://raw.githubusercontent.com/anchore/chronicle/main/install.sh | sh -s -- -b  

إعدادات

مسارات البحث عن التكوين:

• .chronicle.yaml

• .chronicle/config.yaml

• ~/.chronicle.yaml

• /chronicle/config.yaml

القيم الافتراضية

خيارات التكوين (قيم المثال هي الافتراضية):

 # تنسيق الإخراج لسجل التغيير # مثل -o و--output وCHRONICLE_OUTPUT env varoutput: md# قم بقمع جميع مخرجات التسجيل # نفس -q ؛ CHRONICLE_QUIET env varquiet: false# جميع خيارات التسجيل: # استخدم التسجيل المنظم # مثل CHRONICLE_LOG_STRUCTURED env var Structured: false # مستوى السجل # نفس مستوى CHRONICLE_LOG_LEVEL env varlevel: "warn" # موقع لكتابة ملف السجل (الافتراضي ليس لـ لديك ملف سجل) # مثل CHRONICLE_LOG_FILE env var file: ""# خمن ما هو الإصدار التالي بناءً على الإصدار الحالي ومجموعة التغييرات (لا يمكن استخدامه مع --until-tag)# مثل --speculate-next-version / -n ; CHRONICLE_SPECULATE_NEXT_VERSION env varspeculate-next-version: false# يتجاوز علامة بوابة البداية لسجل التغيير (الإعداد الافتراضي هو اكتشاف الإصدار الأخير تلقائيًا)# تمامًا مثل --since-tag / -s ؛ CHRONICLE_SINCE_TAG env varsince-tag: ""# تجاوز علامة git النهائية لسجل التغيير (الافتراضي هو استخدام العلامة أو الالتزام في git HEAD)# مثل --until-tag / -u ; CHRONICLE_SINCE_TAG env varuntil-tag: ""# إذا كان إصدار الإصدار الحالي < v1.0، فإن كسر التغييرات سيؤدي إلى ظهور حقل الإصدار الثانوي # مثل CHRONICLE_ENFORCE_V0 env varenforce-v0: false# العنوان المستخدم لسجل التغيير # مثل CHRONICLE_TITLEtitle: Changelog# جميع الإعدادات المتعلقة بـ githubgithub:
    # مضيف github المطلوب استخدامه (تجاوز عمليات نشر مؤسسة github) # مثل CHRONICLE_GITHUB_HOST env var host: github.com
    # لا تأخذ في الاعتبار أي مشكلات أو علاقات عامة مع أي من التصنيفات المحددة # مثل CHRONICLE_GITHUB_EXCLUDE_LABELS env var Exception-labels:
    - ينسخ
    - سؤال
    - غير صالح
    - متعود الإصلاح
    - لن يتم الإصلاح
    - الافراج عن تجاهل
    - تجاهل سجل التغيير
    - يتجاهل
    # اعتبر العلاقات العامة المدمجة كإدخالات سجل التغيير للمرشح (يجب أن تحتوي على تسمية مطابقة من إدخال 'github.changes') # مثل CHRONICLE_GITHUB_INCLUDE_PRS env var include-prs: true # اعتبر المشكلات المغلقة كإدخالات سجل التغيير للمرشح (يجب أن تحتوي على تسمية مطابقة من إدخال 'github.changes') # مثل CHRONICLE_GITHUB_INCLUDE_ISSUES env var include-issues: صحيح # يمكن النظر في المشكلات فقط لمرشحي سجل التغيير إذا كان لديهم علاقات عامة مرتبطة تم دمجها (ملاحظة: لا يتطلب تعيين github.include-issues) # مثل CHRONICLE_GITHUB_ISSUES_REQUIRE_LINKED_PRS env var issues-require-linked-prs : خطأ شنيع
    # قائمة تعريفات التسميات المطبقة على المشكلات أو العلاقات العامة التي تشكل إدخالاً في سجل التغيير. تحدد هذه الإدخالات أيضًا قسم سجل التغيير وعنوان سجل التغيير وحقل سيمفر الذي يمثل فئة التغيير على أفضل وجه.  # ملاحظة: لا يمكن ضبطها عبر تغييرات متغيرات البيئة: [...<قائمة الإدخالات>...] # راجع قسم "تغيير تعريفات GitHub الافتراضية" لمزيد من التفاصيل

تعريفات تغيير GitHub الافتراضية

إن github.changes القابل للتكوين عبارة عن قائمة من التعيينات، يأخذ كل منها الحقول التالية:

• name : [سلسلة] اسم مفرد، صغير، مفصول بواصلة (بدون مسافات) يمثل التغيير على أفضل وجه (على سبيل المثال، "تغيير جذري"، "أمان"، "ميزة إضافية"، "تحسين"، "ميزة جديدة"، إلخ).

• title : [سلسلة] عنوان القسم في سجل التغيير الذي يسرد جميع الإدخالات.

• semver-field : [string] ستؤدي إدخالات التغيير إلى زيادة حقل semver المعني عند تخمين إصدار الإصدار التالي. القيم المسموح بها: major أو minor أو patch .

• labels : [قائمة السلاسل] جميع المشكلات أو تسميات العلاقات العامة التي يجب أن تتطابق مع قسم التغيير هذا.

القيمة الافتراضية لـ github.changes هي:

 - الاسم: عنوان إصلاحات الأمان: حقل إصلاحات الأمان: تسميات التصحيح:
    - حماية
    - وهن
  - الاسم: عنوان الميزة المضافة: الميزات المضافة حقل سيمفر: تسميات ثانوية:
    - التعزيز
    - ميزة
    - صغير
  - الاسم: عنوان إصلاح الأخطاء: إصلاحات الأخطاء حقل سيمفر: تسميات التصحيح:
    - حشرة
    - يصلح
    - إصلاح الخلل
    - رقعة
  - الاسم: عنوان ميزة التعطيل: حقل فاصل التغييرات: التسميات الرئيسية:
    - كسر
    - غير متوافق مع الوراء
    - كسر التغيير
    - خاصية الكسر
    - رئيسي
    - الاسم: عنوان الميزة التي تمت إزالتها: حقل الميزات التي تمت إزالتها: التسميات الرئيسية:
    - تمت إزالته
  - الاسم: عنوان الميزة المهملة: الميزات المهملة حقل سيمفر: تسميات ثانوية:
    - مهمل- الاسم: عنوان غير معروف: تغييرات إضافية