Skip to content

[DOCS] Simplify PR title syntax toward Conventional Commits #9

[DOCS] Simplify PR title syntax toward Conventional Commits

[DOCS] Simplify PR title syntax toward Conventional Commits #9

---
# 🦫 Standard Overture Maps Foundation PR checks.
#
# Bundles the following checks:
# - PR Title: Validates PR titles against Overture's [TYPE] bracket format
# - Check Issue: Enforces that PRs have a linked GitHub issue
#
# Designed to run as a GitHub Ruleset required workflow.
#
name: OMF PR Checks
on: # zizmor: ignore[concurrency-limits]
pull_request_target: # zizmor: ignore[dangerous-triggers]
types: [opened, reopened, edited, synchronize]
# pull_request_target runs with write permissions so this workflow works for fork PRs.
# SECURITY: This workflow must never check out or execute code from the PR branch.
# If you need to add a step that does so, use the workflow_run pattern instead.
permissions:
contents: none # no repository content access needed
jobs:
validate-pr-title:
name: title
permissions:
contents: none # no repository content access needed
pull-requests: write # to post PR title validation comments
issues: write # to post PR-related issue comments
statuses: write # to update commit status checks
uses: OvertureMaps/workflows/.github/workflows/validate-pr-title.yml@main # zizmor: ignore[unpinned-uses]
check-linked-issue:
name: issue
runs-on: ubuntu-latest
permissions:
contents: none # no repository content access needed
pull-requests: read # to query PR metadata and closing issue references
statuses: write # to update commit status checks
steps:
- name: Check for linked issue
uses: OvertureMaps/workflows/.github/actions/check-linked-issue@main # zizmor: ignore[unpinned-uses]
with:
privateKey: ${{ secrets.CHECK_LINKED_ISSUE_APP_PEM }} # zizmor: ignore[secrets-outside-env]