docs: update namespace table of contents #15
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
| #/ | |
| # @license Apache-2.0 | |
| # | |
| # Copyright (c) 2024 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_contributing_guidelines_acceptance | |
| # Workflow triggers: | |
| on: | |
| # Allow the workflow to be triggered by other workflows | |
| workflow_call: | |
| # Define the input parameters for the workflow: | |
| inputs: | |
| pull_request_number: | |
| description: 'Pull request number' | |
| required: true | |
| type: number | |
| user: | |
| required: true | |
| type: string | |
| # Define the secrets accessible by the workflow: | |
| secrets: | |
| STDLIB_BOT_GITHUB_TOKEN: | |
| description: 'stdlib-bot GitHub token to create pull request comments' | |
| required: true | |
| # Trigger on pull request events: | |
| pull_request_target: | |
| types: [opened, edited, synchronize, reopened] | |
| # Global permissions: | |
| permissions: | |
| # Allow read-only access to the repository contents: | |
| contents: read | |
| # Allow write access to pull requests: | |
| pull-requests: write | |
| # Workflow jobs: | |
| jobs: | |
| # Define a job for checking the contributing guidelines acknowledgment... | |
| check_acknowledgment: | |
| # Define a display name: | |
| name: 'Check Contributing Guidelines Acknowledgment' | |
| # Define the type of virtual host machine: | |
| runs-on: ubuntu-latest | |
| # Define the sequence of job steps... | |
| steps: | |
| # Checkout the repository: | |
| - name: 'Checkout repository' | |
| # Pin action to full length commit SHA | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| with: | |
| # Specify whether to remove untracked files before checking out the repository: | |
| clean: true | |
| # Limit clone depth to the most recent commit: | |
| fetch-depth: 1 | |
| # Specify whether to download Git-LFS files: | |
| lfs: false | |
| timeout-minutes: 10 | |
| # Check contributing guidelines acceptance: | |
| - name: 'Check contributing guidelines acceptance' | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }} | |
| PR_NUMBER: ${{ github.event.pull_request.number || inputs.pull_request_number }} | |
| run: | | |
| . "$GITHUB_WORKSPACE/.github/workflows/scripts/check_contributing_guidelines_acceptance" $PR_NUMBER |