BackwardCompatibilityCheck

فحص التوافق المتخلف

أداة يمكن استخدامها للتحقق من فواصل BC بين نسختين من مكتبة PHP.

المتطلبات المسبقة/الافتراضات

• يستخدم مشروعك git
• يستخدم مشروعك composer.json لتحديد تبعياته
• يتم تغطية جميع مسارات المصدر بواسطة قسم "autoload" في composer.json
• يجب أن تلتزم التغييرات git لتغطية. يمكنك تنفيذ المنطق الخاص بك لاستخراج المصادر وتبعيات من المشروع.

تثبيت

composer require --dev roave/backward-compatibility-check

تثبيت مع Docker

يمكنك أيضًا استخدام Docker لتشغيل roave-backward-compatibility-check :

docker run --rm -v ` pwd ` :/app nyholm/roave-bc-check

الاستخدام

إضافة إلى خط أنابيب التكامل المستمر

الاستخدام المقصود المعتاد هو مجرد إضافة roave-backward-compatibility-check مع بنية CI الخاصة بك:

vendor/bin/roave-backward-compatibility-check

سيؤدي ذلك تلقائيًا إلى اكتشاف آخر إصدار ثانوي تم وضع علامة عليه ، ومقارنة واجهة برمجة التطبيقات مقابل HEAD الحالي. إذا تم العثور على أي فواصل قبل الميلاد ، فإن الأداة تُرجع حالة غير صفرية ، والتي ستتسبب في معظم أنظمة CI في فشل البناء.

ملاحظة: لا يعمل اكتشاف الإصدار الأساسي فقط إذا كان لديك علامات GIT بتنسيق xyz متوافق مع SEMVER ، مثل 1.2.3 .

ملاحظة: نظرًا لأن هذه الأداة تعتمد على العلامات ، فأنت بحاجة إلى التأكد من جلب العلامات كجزء من خط أنابيب CI الخاص بك. على سبيل المثال في إجراء github ، لاحظ استخدام fetch-depth: 0 :

 jobs :
  roave-backwards-compatibility-check :
    name : Roave Backwards Compatibility Check
    runs-on : ubuntu-latest
    steps :
      - uses : actions/checkout@v2
        with :
          fetch-depth : 0
      - name : " Install PHP "
        uses : shivammathur/setup-php@v2
        with :
          php-version : " 8.0 "
      - name : " Install dependencies "
        run : " composer install "
      - name : " Check for BC breaks "
        run : " vendor/bin/roave-backward-compatibility-check " 

عمل Nyholm Github

يقدم Tobias Nyholm أيضًا إجراءً بسيطًا للجيثب يمكنك استخدامه في خط أنابيب جيثب. نوصي بهذا لمعظم الحالات لأنه من السهل الإعداد:

.github/workflows/main.yml :

 on : [push]
name : Test
jobs :
  roave-backwards-compatibility-check :
    name : Roave Backwards Compatibility Check
    runs-on : ubuntu-latest
    steps :
      - uses : actions/checkout@v2
        with :
          fetch-depth : 0
      - name : " Check for BC breaks "
        uses : docker://nyholm/roave-bc-check-ga

الجري يدويًا

لتوليد وثائق إضافية لـ Changelogs:

vendor/bin/roave-backward-compatibility-check --format=markdown > results.md

أفعال جيثب

عند التشغيل في إجراءات github ، يتم تأييده لاستخدام- --format=github-actions format:

vendor/bin/roave-backward-compatibility-check --format=github-actions

الوثائق

إذا كنت بحاجة إلى مزيد من التوجيه:

vendor/bin/roave-backward-compatibility-check --help

إعدادات

لا يوجد حاليًا أي خيارات تكوين متاحة.