docs: fix README.md #718
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# | |
# Copyright (c) 2024 Contributors to the Eclipse Foundation | |
# | |
# See the NOTICE file(s) distributed with this work for additional | |
# information regarding copyright ownership. | |
# | |
# This program and the accompanying materials are made available under the | |
# terms of the Apache License, Version 2.0 which is available at | |
# https://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. | |
# | |
# SPDX-License-Identifier: Apache-2.0 | |
# | |
name: Scan Pull Request | |
on: | |
pull_request: | |
branches: [ main ] | |
types: [opened, edited, synchronize, reopened, labeled, unlabeled] | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: true | |
jobs: | |
check-pull-request-title: | |
runs-on: ubuntu-latest | |
continue-on-error: false | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: deepakputhraya/action-pr-title@master | |
with: | |
# Match pull request titles conventional commit syntax (https://www.conventionalcommits.org/en/v1.0.0/) | |
# (online tool for regex quick check: https://regex101.com/r/V5J8kh/1) | |
# | |
# Valid examples would be | |
# - fix: resolve minor issue | |
# - docs(Sample5): update docs for configuration | |
# - feat(management-api)!: change path to access contract agreements | |
# | |
# Invalid examples would be | |
# - Add cool feature | |
# - Feature/some cool improvement | |
# - fix: resolve minor issue. | |
regex: '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(\w+((,|\/|\\)?\s?\w+)+\))?!?: [\S ]{1,160}[^\.]$' | |
allowed_prefixes: 'build,chore,ci,docs,feat,fix,perf,refactor,revert,style,test' | |
prefix_case_sensitive: true |