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

สิ่งนี้จะตรวจจับการติดแท็กรุ่นรองล่าสุดโดยอัตโนมัติและเปรียบเทียบ API กับ HEAD ปัจจุบัน หากพบ BC break ใด ๆ เครื่องมือจะส่งกลับสถานะที่ไม่เป็นศูนย์ซึ่งในระบบ 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 อย่างง่ายที่คุณสามารถใช้ในไปป์ไลน์ GitHub ของคุณ เราขอแนะนำสิ่งนี้สำหรับกรณีส่วนใหญ่เนื่องจากเป็นเรื่องง่ายที่จะตั้งค่า:

.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

วิ่งด้วยตนเอง

เพื่อสร้างเอกสารเพิ่มเติมสำหรับการเปลี่ยนแปลง:

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

การกระทำของ GitHub

เมื่อทำงานในการกระทำของ GitHub จะได้รับการรับรองให้ใช้รูปแบบเอาต์พุต --format=github-actions :

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

เอกสาร

หากคุณต้องการคำแนะนำเพิ่มเติม:

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

การกำหนดค่า

ขณะนี้ยังไม่มีตัวเลือกการกำหนดค่า