esp-hal/.github/workflows/changelog.yml

name: Changelog check

on:
  pull_request:
    # We will not track changes for the following packages/directories.
    paths-ignore:
      - "/examples/"
      - "/extras/"
      - "/hil-tests/"
      - "/resources/"
      - "/xtask/"
    # Run on labeled/unlabeled in addition to defaults to detect
    # adding/removing skip-changelog labels.
    types: [opened, reopened, labeled, unlabeled, synchronize]

jobs:
  changelog:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Check which package is modified
        uses: dorny/paths-filter@v3
        id: changes
        with:
          filters: |
            esp-alloc:
              - 'esp-alloc/**'
            esp-backtrace:
              - 'esp-backtrace/**'
            esp-build:
              - 'esp-build/**'
            esp-bootloader-esp-idf:
              - 'esp-bootloader-esp-idf/**'
            esp-config:
              - 'esp-config/**'
            esp-hal:
              - 'esp-hal/**'
            esp-hal-embassy:
              - 'esp-hal-embassy/**'
            esp-hal-procmacros:
              - 'esp-hal-procmacros/**'
            esp-lp-hal:
              - 'esp-lp-hal/**'
            esp-metadata:
              - 'esp-metadata/**'
            esp-preempt:
              - 'esp-preempt/**'
            esp-println:
              - 'esp-println/**'
            esp-riscv-rt:
              - 'esp-riscv-rt/**'
            esp-rom-sys:
              - 'esp-rom-sys/**'
            esp-storage:
              - 'esp-storage/**'
            esp-radio:
              - 'esp-radio/**'
            esp-sync:
              - 'esp-sync/**'
            xtensa-lx:
              - 'xtensa-lx/**'
            xtensa-lx-rt:
              - 'xtensa-lx-rt/**'

      - name: Check that changelog updated (esp-alloc)
        if: steps.changes.outputs.esp-alloc == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-alloc/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-alloc/CHANGELOG.md file."

      - name: Check that changelog updated (esp-backtrace)
        if: steps.changes.outputs.esp-backtrace == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-backtrace/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-backtrace/CHANGELOG.md file."

      - name: Check that changelog updated (esp-build)
        if: steps.changes.outputs.esp-build == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-build/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-build/CHANGELOG.md file."

      - name: Check that changelog updated (esp-bootloader-esp-idf)
        if: steps.changes.outputs.esp-bootloader-esp-idf == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-bootloader-esp-idf/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-bootloader-esp-idf/CHANGELOG.md file."

      - name: Check that changelog updated (esp-config)
        if: steps.changes.outputs.esp-config == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-config/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-config/CHANGELOG.md file."

      - name: Check that changelog updated (esp-hal)
        if: steps.changes.outputs.esp-hal == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-hal/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-hal/CHANGELOG.md file."

      - name: Check that changelog updated (esp-hal-embassy)
        if: steps.changes.outputs.esp-hal-embassy == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-hal-embassy/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-hal-embassy/CHANGELOG.md file."

      - name: Check that changelog updated (esp-hal-procmacros)
        if: steps.changes.outputs.esp-hal-procmacros == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-hal-procmacros/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-hal-procmacros/CHANGELOG.md file."

      - name: Check that changelog updated (esp-lp-hal)
        if: steps.changes.outputs.esp-lp-hal == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-lp-hal/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-lp-hal/CHANGELOG.md file."

      - name: Check that changelog updated (esp-preempt)
        if: steps.changes.outputs.esp-preempt == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-preempt/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-preempt/CHANGELOG.md file."

      - name: Check that changelog updated (esp-println)
        if: steps.changes.outputs.esp-println == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-println/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-println/CHANGELOG.md file."

      - name: Check that changelog updated (esp-riscv-rt)
        if: steps.changes.outputs.esp-riscv-rt == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-riscv-rt/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-riscv-rt/CHANGELOG.md file."

      - name: Check that changelog updated (esp-storage)
        if: steps.changes.outputs.esp-storage == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-storage/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-storage/CHANGELOG.md file."

      - name: Check that changelog updated (esp-radio)
        if: steps.changes.outputs.esp-radio == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-radio/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-radio/CHANGELOG.md file."

      - name: Check that changelog updated (esp-sync)
        if: steps.changes.outputs.esp-sync == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: esp-sync/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the esp-sync/CHANGELOG.md file."

      - name: Check that changelog updated (xtensa-lx)
        if: steps.changes.outputs.xtensa-lx == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: xtensa-lx/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the xtensa-lx/CHANGELOG.md file."

      - name: Check that changelog updated (xtensa-lx-rt)
        if: steps.changes.outputs.xtensa-lx-rt == 'true'
        uses: dangoslen/changelog-enforcer@v3
        with:
          changeLogPath: xtensa-lx-rt/CHANGELOG.md
          skipLabels: "skip-changelog"
          missingUpdateErrorMessage: "Please add a changelog entry in the xtensa-lx-rt/CHANGELOG.md file."

      - name: Changelog format check
        run: cargo xtask check-changelog