action sqlcheck

Action-sqlcheck

การกระทำของ GitHub ที่ระบุการต่อต้านรูปแบบโดยอัตโนมัติในการสืบค้น SQL โดยใช้ SQLCheck เมื่อมีการร้องขอ PR และแสดงความคิดเห็นเกี่ยวกับ PR หากพบความเสี่ยงในแบบสอบถาม

การใช้งาน

รองรับประเภทเหตุการณ์ pull_request

อินพุต

พารามิเตอร์	ที่จำเป็น	ค่าเริ่มต้น	คำอธิบาย
post-comment	เท็จ	จริง	โพสต์ความคิดเห็นไปยัง PR หากเป็นจริง
token	จริง	-	โทเค็น GitHub เพื่อเพิ่มความคิดเห็นในการประชาสัมพันธ์
risk-level	เท็จ	3	ชุด SQL anti-patterns เพื่อตรวจสอบ: 1,2 หรือ 3 - 1 (Anti-Patterns ทั้งหมด, ค่าเริ่มต้น) - 2 (เพียงปานกลางและมีความเสี่ยงสูงต่อต้านรูปแบบ) - 3 (มีความเสี่ยงสูงเพียงต่อต้านรูปแบบ)
verbose	เท็จ	เท็จ	เพิ่มคำเตือน verbose ลงในผลการวิเคราะห์ sqlcheck
postfixes	เท็จ	"SQL"	รายการไฟล์ postfix เพื่อจับคู่ ตัวคั่นที่รองรับคือเครื่องหมายจุลภาค (เสียค่าใช้จ่าย) และ retrun ในสตริงหลายบรรทัด
directories	เท็จ	-	เส้นทางของไดเรกทอรีภายใต้การดำเนินการตรวจสอบไฟล์ใด ๆ ไม่ว่าจะเป็นส่วนหนึ่งของที่เก็บหรือไม่ โดยค่าเริ่มต้นการดำเนินการจะตรวจสอบเฉพาะไฟล์ในแบบสอบถาม PR โดยการระบุไดเรกทอรีการกระทำจะไม่ตรวจสอบไฟล์ในแบบสอบถาม PR อีกต่อไป แต่ไฟล์ภายใต้ไดเรกทอรี (MaxDepth 3) ตัวคั่นที่รองรับจะส่งคืนในสตริงหลายบรรทัด

เอาต์พุต

พารามิเตอร์	คำอธิบาย
issue-found	ค่าบูลีนเพื่อระบุปัญหาที่พบในไฟล์ที่ตรวจสอบการกระทำของ SQLCHECK

ตัวอย่างเวิร์กโฟลว์

ตัวอย่าง 1

.github/Workflows/test1.yml

 name : sqlcheck workflow1
on : pull_request

jobs :
  sqlcheck :
    name : sqlcheck job
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@master
    - uses : yokawasa/[email protected]
      with :
        post-comment : true
        risk-level : 3
        verbose : false
        token : ${{ secrets.GITHUB_TOKEN }}

ตัวอย่าง 2 (อินพุต postfixes และไดเรกทอรี)

.github/Workflows/test2.yml

 name : sqlcheck workflow2
on : pull_request

jobs :
  sqlcheck :
    name : sqlcheck job
    runs-on : ubuntu-latest
    steps :
    - uses : actions/checkout@master
    - uses : yokawasa/[email protected]
      id : sqlcheck
      with :
        post-comment : true
        risk-level : 3
        verbose : true
        token : ${{ secrets.GITHUB_TOKEN }}
        postfixes : |
          sql
          sqlx
          schema
        directories : |
          sql
          build/sql_dir
          tests/sql_dir
    - name : Get output
      run : echo "Issues found in previous step"
      if : steps.sqlcheck.outputs.issue-found