#/

# @license Apache-2.0

#

# Copyright (c) 2025 The Stdlib Authors.

#

# Licensed 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.

#/

# Workflow name:

name: check_commit_metadata

# Workflow triggers:

on:

# Trigger on pull request events:

pull_request_target:

types:

- opened

# Global permissions:

permissions:

# Allow read-only access to the repository contents:

contents: read

# Workflow jobs:

jobs:

# Define a job for checking the commit metadata for whether local development is properly setup...

check_commit_metadata:

# Define a display name:

name: 'Check Commit Metadata'

# Define the type of virtual host machine:

runs-on: ubuntu-latest

# Temporarily disable the entire workflow:

if: false

# Define the sequence of job steps...

steps:

# Checkout the repository:

- name: 'Checkout repository'

# Pin action to full length commit SHA

uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

with:

# Ensure we have access to the scripts directory:

sparse-checkout: |

.github/workflows/scripts

sparse-checkout-cone-mode: false

timeout-minutes: 10

# Extract commit metadata from commit messages as JSON:

- name: 'Extract commit metadata'

id: extract-metadata

# Pin action to full length commit SHA

uses: stdlib-js/metadata-action@3ccf68f24c51ae23470319e8e5619d539df8212b # v3.0.0

# Check commit metadata:

- name: 'Check commit metadata'

env:

PR_NUMBER: ${{ github.event.pull_request.number }}

COMMIT_METADATA: ${{ steps.extract-metadata.outputs.metadata }}

GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}

run: |

. "$GITHUB_WORKSPACE/.github/workflows/scripts/check_commit_metadata/run" $PR_NUMBER $COMMIT_METADATA