Changelog Generator
Generate polished, well-structured changelogs from raw commit messages, feature lists, or release notes — in any standard format.
كيفية الاستخدام Changelog Generator
- الصق تغييراتك الخام — رسائل الالتزام، قوائم الميزات، ملخصات تذاكر Jira، أو ملاحظات نقطية من مراجعة السبرينت الخاصة بك.
- اختر تنسيق سجل التغييرات: 'Keep a Changelog' هو المعيار المجتمعي، و 'تقليدي' يتبع مواصفات الالتزامات التقليدية.
- أدخل رقم الإصدار ونوع الإصدار لتعيين العنوان والسياق الصحيحين.
- اختر جمهورك — تشمل سجلات التغييرات للمطورين تفاصيل فنية؛ تركز سجلات التغييرات للمستخدمين النهائيين على الفوائد والتأثير.
حالات الاستخدام
إنشاء إدخال CHANGELOG.md من مخرجات سجل git قبل الإصدار
إنشاء ملاحظات إصدار موجهة للمستخدمين لبريد إلكتروني لتحديث منتج SaaS
أنتج سجلات تغيير لجمهور مزدوج لمكتبات المصدر المفتوح (المحافظون + المستخدمون)
قم بتجميع تغييرات السبرينت في ملخص إصدار منظم للمساهمين
وثق التغييرات الكبيرة مع أدلة الترحيل لزيادة الإصدارات الرئيسية
نصائح للحصول على أفضل النتائج
- الصق مخرجات سجل git الخام مباشرة - سيقوم المولد بتصنيف الالتزامات تلقائيًا إلى أقسام تمت إضافتها/تم تغييرها/تم إصلاحها/تمت إزالتها.
- بالنسبة للتغييرات الكبيرة، قم بتضمين السلوك القديم والجديد في مدخلاتك حتى يتمكن المولد من كتابة تعليمات الهجرة المناسبة.
- استخدم خيار الجمهور 'كلاهما' لمشاريع المصدر المفتوح حيث يخدم سجل التغييرات الخاص بك كل من المطورين والمستخدمين غير التقنيين.
- قم بإنشاء سجلات تغييرات تدريجية لكل إصدار بدلاً من محاولة تغطية إصدارات متعددة دفعة واحدة.
أسئلة شائعة
ما هو تنسيق سجل التغييرات الذي يجب أن أستخدمه؟
Keep a Changelog (keepachangelog.com) هو المعيار الأكثر اعتمادًا لمشاريع المصدر المفتوح. يتناسب Conventional Changelog بشكل جيد مع Conventional Commits (feat:، fix:، إلخ). تعتبر ملاحظات إصدار المعاني الدلالية الأفضل للمكتبات التي تحمل أرقام الإصدار معاني صارمة.
هل يمكنني لصق رسائل التزام git مباشرة؟
نعم. ألصق مخرجات 'git log --oneline' أو ما شابه. يقوم المولد بتصنيف كل التزام في القسم الصحيح من سجل التغييرات (مضاف، معدل، تم إصلاحه، إلخ) ويعيد كتابة رسائل الالتزام الموجزة إلى إدخالات سجل تغييرات واضحة ووصفية.
كيف يتعامل مع التغييرات الجذرية؟
تُميز التغييرات الجذرية بشكل بارز في أعلى سجل التغييرات مع بادئة تغيير جذري. إذا قدمت تفاصيل حول السلوك القديم والجديد، يتضمن المُولد تعليمات ترحيل لمساعدة المستخدمين على الترقية.
ما الفرق بين سجلات التغييرات للمطورين وسجلات التغييرات للمستخدمين النهائيين؟
تتضمن سجلات التغييرات للمطورين تفاصيل تقنية: أسماء الوظائف، تغييرات API، تحديثات التبعيات، وأمثلة على الشيفرة. تترجم سجلات التغييرات الخاصة بالمستخدم النهائي نفس التغييرات إلى بيانات فوائد: 'الصفحات الآن تُحمّل أسرع بنسبة 50%' بدلاً من 'تم الانتقال إلى React Server Components'.
هل يمكنني إنشاء سجلات التغييرات للإصدارات السابقة للإصدار؟
نعم. اختر 'الإصدار المسبق' كنوع الإصدار واستخدم إصدارًا مثل 3.0.0-beta.1. سيلاحظ المولد حالة الإصدار المسبق ويضيف إخلاء مسؤولية مناسب حول استقرار واجهة برمجة التطبيقات.
Part of these workflows
This tool is used in step-by-step guides that help you get more done
نحن لا نخزن نصك. تتم المعالجة في الوقت الحقيقي ويتم التخلص من إدخالك على الفور بعد توليد النتيجة.
فتح الوصول غير المحدود
المستخدمون المجانيون: 10 استخدامات في اليوم | المستخدمون المحترفون: غير محدود
See how this tool stacks up side-by-side: