พงศาวดาร

พงศาวดาร

เครื่องมือสร้างบันทึกการเปลี่ยนแปลงที่รวดเร็วที่รวบรวมการเปลี่ยนแปลงจาก GitHub PR และปัญหาต่างๆ ซึ่งจัดระเบียบตามป้ายกำกับ

สร้างบันทึกการเปลี่ยนแปลงจาก GitHib รุ่นล่าสุดจนถึงแท็ก git HEAD ปัจจุบัน/คอมมิตสำหรับ repo git ในไดเร็กทอรีปัจจุบัน:

 พงศาวดาร

สร้างบันทึกการเปลี่ยนแปลงที่มีการเปลี่ยนแปลงทั้งหมดตั้งแต่ v0.16.0 จนถึงแท็ก git HEAD ปัจจุบัน/คอมมิตสำหรับ git repo ในไดเร็กทอรีปัจจุบัน:

 พงศาวดาร --since-tag v0.16.0

สร้างบันทึกการเปลี่ยนแปลงระหว่างสองแท็กเฉพาะสำหรับ repo ในเส้นทางที่กำหนด

 พงศาวดาร --since-tag v0.16.0 --until-tag v0.18.0 ./path/to/git/repo

สร้างบันทึกการเปลี่ยนแปลงและเดาเวอร์ชันที่เผยแพร่จากชุดการเปลี่ยนแปลงในบันทึกการเปลี่ยนแปลง

 พงศาวดาร -n

เพียงเดาเวอร์ชันถัดไปตามชุดการเปลี่ยนแปลง (อย่าสร้างบันทึกการเปลี่ยนแปลง)

 พงศาวดารรุ่นถัดไป

การติดตั้ง

 curl -sSfL https://raw.githubusercontent.com/anchore/chronicle/main/install.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# ตัวเลือกการบันทึกทั้งหมดlog: # ใช้การบันทึกแบบมีโครงสร้าง # เหมือนกับ CHRONICLE_LOG_STRUCTURED env var โครงสร้าง: false # ระดับการบันทึก # เหมือนกับ CHRONICLE_LOG_LEVEL ระดับ env var: "เตือน" # ตำแหน่งที่จะเขียนไฟล์บันทึก (ค่าเริ่มต้นคือไม่ มีไฟล์บันทึก) # เหมือนกับไฟล์ CHRONICLE_LOG_FILE env var: ""# Guess เวอร์ชันถัดไปที่เผยแพร่จะขึ้นอยู่กับเวอร์ชันปัจจุบันและชุดการเปลี่ยนแปลง (ไม่สามารถใช้กับ --until-tag)# เช่นเดียวกับ --speculate-next-version / -n ; CHRONICLE_SPECULATE_NEXT_VERSION env varspeculate-next-version: false# แทนที่แท็ก git เริ่มต้นสำหรับบันทึกการเปลี่ยนแปลง (ค่าเริ่มต้นคือการตรวจจับรุ่นล่าสุดโดยอัตโนมัติ)# เช่นเดียวกับ --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# การตั้งค่าที่เกี่ยวข้องกับ github ทั้งหมด github:
    # โฮสต์ github ที่จะใช้ (แทนที่สำหรับการปรับใช้องค์กร github) # เหมือนกับ CHRONICLE_GITHUB_HOST env var host: github.com
    # อย่าพิจารณาปัญหาหรือ PR ใดๆ กับป้ายกำกับที่ระบุ # เช่นเดียวกับ CHRONICLE_GITHUB_EXCLUDE_LABELS env var ไม่รวมป้ายกำกับ:
    - ทำซ้ำ
    - คำถาม
    - ไม่ถูกต้อง
    - จะไม่แก้ไข
    - ไม่แก้ไข
    - ปล่อยละเลย
    - บันทึกการเปลี่ยนแปลง-ละเว้น
    - ไม่สนใจ
    # พิจารณา PR ที่รวมเข้าด้วยกันเป็นรายการบันทึกการเปลี่ยนแปลงของผู้สมัคร (ต้องมีป้ายกำกับที่ตรงกันจากรายการ 'github.changes') # เหมือนกับ CHRONICLE_GITHUB_INCLUDE_PRS env var include-prs: true # พิจารณาประเด็นที่ปิดแล้วเป็นรายการบันทึกการเปลี่ยนแปลงของผู้สมัคร (ต้องมีป้ายกำกับที่ตรงกันจาก รายการ 'github.changes') # เช่นเดียวกับ CHRONICLE_GITHUB_INCLUDE_ISSUES env var include-issues: จริง # ปัญหาสามารถพิจารณาได้สำหรับผู้สมัครบันทึกการเปลี่ยนแปลงเท่านั้น หากมีการเชื่อมโยง PRs ที่รวมเข้าด้วยกัน (หมายเหตุ: ไม่ต้องตั้งค่า github.include-issues) # เช่นเดียวกับ CHRONICLE_GITHUB_ISSUES_REQUIRE_LINKED_PRS env var problems-require-linked-prs: false
    # รายการคำจำกัดความของป้ายกำกับที่ใช้กับปัญหาหรือ PRs ที่ประกอบขึ้นเป็นรายการบันทึกการเปลี่ยนแปลง รายการเหล่านี้ยังกำหนด # ส่วนบันทึกการเปลี่ยนแปลง ชื่อบันทึกการเปลี่ยนแปลง และฟิลด์ semver ที่แสดงถึงคลาสของการเปลี่ยนแปลงได้ดีที่สุด  # หมายเหตุ: ไม่สามารถตั้งค่าผ่านการเปลี่ยนแปลงตัวแปรสภาพแวดล้อม: [...<รายการรายการ>...] # ดูส่วน "คำจำกัดความการเปลี่ยนแปลงเริ่มต้น GitHub" สำหรับรายละเอียดเพิ่มเติม

ข้อกำหนดการเปลี่ยนแปลง GitHub เริ่มต้น

github.changes ที่กำหนดค่าได้คือรายการการแมป โดยแต่ละรายการจะมีฟิลด์ต่อไปนี้:

• name : [string] ชื่อเอกพจน์ ตัวพิมพ์เล็ก คั่นด้วยยัติภังค์ (ไม่มีการเว้นวรรค) ชื่อที่แสดงถึงการเปลี่ยนแปลงได้ดีที่สุด (เช่น "การเปลี่ยนแปลงที่แตกหัก" "ความปลอดภัย" "คุณลักษณะเพิ่มเติม" "การปรับปรุง" "คุณลักษณะใหม่" ฯลฯ)

• title : [string] ชื่อของส่วนในบันทึกการเปลี่ยนแปลงที่แสดงรายการทั้งหมด

• semver-field : [string] รายการการเปลี่ยนแปลงจะชนฟิลด์ semver ที่เกี่ยวข้องเมื่อคาดเดาเวอร์ชันถัดไป ค่าที่อนุญาต: major , minor หรือ patch

• labels : [รายการสตริง] ปัญหาทั้งหมดหรือป้ายกำกับ PR ที่ควรตรงกับส่วนการเปลี่ยนแปลงนี้

ค่าเริ่มต้นสำหรับ github.changes คือ:

 - ชื่อ: หัวข้อการแก้ไขความปลอดภัย: การแก้ไขความปลอดภัย semver-field: ป้ายกำกับแพทช์:
    - ความปลอดภัย
    - ความเปราะบาง
  - ชื่อ: ชื่อคุณสมบัติที่เพิ่ม: เพิ่มคุณสมบัติ semver-field: ป้ายกำกับรอง:
    - การเพิ่มประสิทธิภาพ
    - คุณสมบัติ
    - ส่วนน้อย
  - ชื่อ: ชื่อการแก้ไขข้อบกพร่อง: แก้ไขข้อผิดพลาด semver-field: ป้ายกำกับแพทช์:
    - บั๊ก
    - แก้ไข
    - แก้ไขข้อผิดพลาด
    - แพทช์
  - ชื่อ: ชื่อเรื่องการทำลายคุณลักษณะ: การเปลี่ยนแปลงที่แตกหัก semver-field: ป้ายกำกับหลัก:
    - ทำลาย
    - ย้อนกลับเข้ากันไม่ได้
    - ทำลายการเปลี่ยนแปลง
    - คุณสมบัติทำลาย
    - วิชาเอก
    - ชื่อ: ชื่อคุณลักษณะที่ถูกลบ: คุณลักษณะที่ถูกลบ semver-field: ป้ายกำกับหลัก:
    - ลบออก
  - ชื่อ: ชื่อคุณลักษณะที่เลิกใช้แล้ว: คุณลักษณะที่เลิกใช้แล้ว semver-field: ป้ายกำกับรอง:
    - เลิกใช้แล้ว- ชื่อ: ไม่ทราบชื่อ: การเปลี่ยนแปลงเพิ่มเติม