Update related packages sections #195
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) 2022 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_required_files | |
| # Workflow triggers: | |
| on: | |
| # Trigger the workflow when a PR review is requested: | |
| pull_request_target: | |
| types: [review_requested] | |
| # Global permissions: | |
| permissions: | |
| # Allow read-only access to the repository contents: | |
| contents: read | |
| # Workflow jobs: | |
| jobs: | |
| # Define a job for checking that pull requests contain the required files... | |
| check_required_files: | |
| # Define a display name: | |
| name: 'Check Required Files' | |
| # 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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| # Specify whether to remove untracked files before checking out the repository: | |
| clean: true | |
| # Refers to the development branch: | |
| ref: 'develop' | |
| # Refers to the repository name of the pull request: | |
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |
| # Limit clone depth to the most recent commit: | |
| fetch-depth: 1 | |
| # Specify whether to download Git-LFS files: | |
| lfs: false | |
| timeout-minutes: 10 | |
| # Check if the review is requested from the `stdlib-bot` user: | |
| - name: 'Check if review is requested from stdlib-bot' | |
| id: check-reviewers | |
| run: | | |
| # Get the list of reviewers: | |
| reviewers=$(jq -r '.pull_request.requested_reviewers | .[] | .login' "$GITHUB_EVENT_PATH") | |
| # Check if the list of reviewers contains the `stdlib-bot` user: | |
| if [[ $reviewers == *"stdlib-bot"* ]]; then | |
| echo "is_stdlib_bot=true" >> $GITHUB_OUTPUT | |
| else | |
| echo "is_stdlib_bot=false" >> $GITHUB_OUTPUT | |
| fi | |
| # Configure git: | |
| - name: 'Configure git' | |
| if: steps.check-reviewers.outputs.is_stdlib_bot == 'true' | |
| run: | | |
| git config --local user.email "[email protected]" | |
| git config --local user.name "stdlib-bot" | |
| git fetch --all | |
| # Get list of added files: | |
| - name: 'Get list of added files' | |
| if: steps.check-reviewers.outputs.is_stdlib_bot == 'true' | |
| id: added-files | |
| run: | | |
| page=1 | |
| files="" | |
| while true; do | |
| new_files=$(curl -s -H "Accept: application/vnd.github.v3+json" -H "Authorization: Bearer ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}" "https://api.github.com/repos/stdlib-js/stdlib/pulls/${{ github.event.pull_request.number }}/files?page=$page&per_page=100" | jq -r '.[] | select(.status == "added") | .filename') | |
| if [ -z "$new_files" ]; then | |
| break | |
| fi | |
| files="$files $new_files" | |
| page=$((page+1)) | |
| done | |
| files=$(echo "$files" | tr '\n' ' ' | sed 's/ $//') | |
| echo "files=${files}" >> $GITHUB_OUTPUT | |
| # Check whether the pull request contains a new `README.md` file; if not, exit with a non-zero exit code: | |
| - name: 'Exit if pull request does not contain a new README.md file' | |
| if: steps.check-reviewers.outputs.is_stdlib_bot == 'true' | |
| run: | | |
| if [[ ! "${{ steps.added-files.outputs.files }}" =~ "README.md" ]]; then | |
| echo "Pull request does not contain a new README.md file." | |
| exit 1 | |
| fi | |
| # Check whether the pull request contains files which are required to be present for all packages: | |
| - name: 'Check whether the pull request contains files which are required to be present for all packages' | |
| if: steps.check-reviewers.outputs.is_stdlib_bot == 'true' | |
| id: check-required-files | |
| run: | | |
| # Define a list of required files: | |
| required_files=( | |
| "package.json" | |
| "README.md" | |
| "docs/repl.txt" | |
| "docs/types/index.d.ts" | |
| "docs/types/test.ts" | |
| "lib/index.js" | |
| "lib/main.js" | |
| "benchmark/benchmark.js" | |
| "examples/index.js" | |
| "test/test.js" | |
| ) | |
| # Get path of first added `README.md` file: | |
| readme_path=$(echo "${{ steps.added-files.outputs.files }}" | tr ' ' '\n' | grep -E 'README.md$' | head -n 1) | |
| if grep -q '## CLI' "${readme_path}"; then | |
| required_files+=("bin/cli") | |
| required_files+=("docs/usage.txt") | |
| required_files+=("etc/cli_opts.json") | |
| required_files+=("test/test.cli.js") | |
| fi | |
| if grep -q '## C APIs' "${readme_path}"; then | |
| required_files+=("manifest.json") | |
| required_files+=("binding.gyp") | |
| required_files+=("include.gypi") | |
| required_files+=("src/Makefile") | |
| required_files+=("include/stdlib") | |
| fi | |
| if grep -q '### Examples\n\n```c' "${readme_path}"; then | |
| required_files+=("examples/c/example.c") | |
| required_files+=("examples/c/Makefile") | |
| required_files+=("benchmark/c/Makefile") | |
| required_files+=("benchmark/c/benchmark.c") | |
| fi | |
| # Define a list of missing files: | |
| missing_files=() | |
| # Define a string with a Markdown list of checkboxes for all files: | |
| checkbox_list="" | |
| # Iterate over the list of required files: | |
| for file in "${required_files[@]}"; do | |
| # Check whether the file is present in the pull request: | |
| if [[ ! "${{ steps.added-files.outputs.files }}" =~ "${file}" ]]; then | |
| # If not, add the file to the list of missing files: | |
| missing_files+=("${file}") | |
| # Add a non-ticked checkbox for the file to the Markdown list of checkboxes: | |
| checkbox_list+="- [ ] ${file}" | |
| else | |
| # Add a ticked checkbox for the file to the Markdown list of checkboxes: | |
| checkbox_list+="- [x] ${file}" | |
| fi | |
| # Add a newline to the Markdown list of checkboxes: | |
| checkbox_list+=" | |
| " | |
| done | |
| # Add the list of missing and required files to the workflow output: | |
| echo "missing_files=${missing_files[*]}" >> $GITHUB_OUTPUT | |
| echo "required_files=${required_files[*]}" >> $GITHUB_OUTPUT | |
| body="" | |
| if [[ "${#missing_files[@]}" -eq 0 ]]; then | |
| body="Hi @${{ github.event.pull_request.user.login }}, thank you for your contribution! | |
| :tada: Your pull request contains all required files for the new package: :tada: | |
| ${checkbox_list} | |
| -- stdlib-bot" | |
| else | |
| body="Hi @${{ github.event.pull_request.user.login }}, thank you for your contribution! Your pull request contains a new package, but is missing some of the required files. | |
| Use the following checklist to keep track of the required files and which ones are still missing: | |
| ${checkbox_list} | |
| Please add the missing files to the pull request. | |
| -- stdlib-bot" | |
| fi | |
| # Add the comment body to the workflow output after escaping to preserve newlines: | |
| body="${body//'%'/'%25'}" | |
| body="${body//$'\n'/'%0A'}" | |
| body="${body//$'\r'/'%0D'}" | |
| echo "comment-body=${body}" >> $GITHUB_OUTPUT | |
| shell: bash | |
| timeout-minutes: 10 | |
| # Create a comment on the pull request informing the user whether the pull request is missing required files: | |
| - name: 'Create a comment on the pull request informing the user whether the pull request is missing required files' | |
| if: steps.check-reviewers.outputs.is_stdlib_bot == 'true' | |
| # Pin action to full length commit SHA | |
| uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0 | |
| with: | |
| # Specify the issue or pull request number: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| # Specify the comment body: | |
| body: ${{ steps.check-required-files.outputs.comment-body }} |