ci-semantic-pull-request.yml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.


name: Semantic Pull Request

on:
  pull_request:
    types:
      - opened
      - reopened
      - edited

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event.number }}
  cancel-in-progress: true

jobs:
  main:
    name: Check pull request title
    runs-on: ubuntu-latest
    steps:
      - uses: amannn/action-semantic-pull-request@v5.0.2
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          # Type abbreviation comments:
          # feat -> feature
          types: |
            cleanup
            feat
            fix
            improve
            refactor
            revert
          # Scope abbreviation comments:
          # cli     -> command line interface
          # fn      -> Pulsar Functions
          # io      -> Pulsar Connectors
          # offload -> tiered storage
          # sec     -> security
          # sql     -> Pulsar Trino Plugin
          # txn     -> transaction
          # ws      -> websocket
          # ml      -> managed ledger
          # zk      -> zookeeper
          # bk      -> bookkeeper
          scopes: |
            admin
            bk
            broker
            build
            ci
            cli
            client
            doc
            fn
            io
            meta
            misc
            ml
            monitor
            offload
            proxy
            schema
            sec
            site
            sql
            storage
            test
            txn
            ws
            zk
          # The pull request's title should be fulfilled the following pattern:
          #
          #     [<type>][<optional scope>] <description>
          #
          # ... where valid types and scopes can be found above; for example:
          #
          #     [fix][test] flaky test V1_ProxyAuthenticationTest.anonymousSocketTest
          headerPattern: '^\[(\w*?)\](?:\[(.*?)\])?(?:\s*)(.*)$'
          headerPatternCorrespondence: type, scope, subject