Update namespace table of contents #403
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) 2021 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: markdown_tocs | |
| # Workflow triggers: | |
| on: | |
| pull_request_target: | |
| branches: | |
| - develop | |
| types: | |
| - closed | |
| # Allow the workflow to be manually run: | |
| workflow_dispatch: | |
| # Workflow jobs: | |
| jobs: | |
| # Define a job for updating namespace table of contents... | |
| update: | |
| # Define a display name: | |
| name: 'Update namespace ToCs' | |
| # Only run this job if the pull request was merged and did not have label `automated-pr` (or the job was triggered manually): | |
| if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'automated-pr') == false || github.event_name == 'workflow_dispatch' | |
| # Define the type of virtual host machine: | |
| runs-on: ubuntu-latest | |
| # Define the sequence of job steps... | |
| steps: | |
| # Checkout the repository: | |
| - name: 'Checkout repository' | |
| uses: actions/checkout@v3 | |
| 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 | |
| # Install Node.js: | |
| - name: 'Install Node.js' | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: '16' # 'lts/*' | |
| timeout-minutes: 5 | |
| # Install dependencies (accounting for possible network failures, etc, when installing node module dependencies): | |
| - name: 'Install dependencies' | |
| run: | | |
| make install-node-modules || make install-node-modules || make install-node-modules | |
| timeout-minutes: 15 | |
| # Initialize development environment: | |
| - name: 'Initialize development environment' | |
| run: | | |
| make init | |
| timeout-minutes: 5 | |
| # Generate list of namespace READMEs: | |
| - name: 'Generate list of namespace READMEs' | |
| run: | | |
| echo "files=$( make list-pkgs-namespace-readmes | tr '\n' ' ' )" >> $GITHUB_OUTPUT | |
| id: namespace_files | |
| # Update namespace table of contents: | |
| - name: 'Update tables of contents' | |
| run: | | |
| make markdown-namespace-tocs-files FILES="${{ steps.namespace_files.outputs.files }}" | |
| make markdown-pkg-urls-files FILES="${{ steps.namespace_files.outputs.files }}" | |
| timeout-minutes: 60 | |
| # Disable Git hooks: | |
| - name: 'Disable Git hooks' | |
| run: | | |
| rm -rf .git/hooks | |
| # Create a pull request with the updated tables of contents: | |
| - name: 'Create pull request' | |
| id: cpr | |
| uses: peter-evans/create-pull-request@v5 | |
| with: | |
| title: 'Update namespace table of contents' | |
| body: | | |
| This PR | |
| - updates namespace table of contents | |
| commit-message: 'docs: update namespace table of contents' | |
| committer: 'stdlib-bot <noreply@stdlib.io>' | |
| token: ${{ secrets.PULL_REQUEST_TOKEN }} | |
| labels: | | |
| documentation | |
| automated-pr | |
| team-reviewers: | | |
| reviewers | |
| branch: update-namespace-tocs | |
| delete-branch: true | |
| # Create Markdown summary of the pull request: | |
| - name: 'Create summary' | |
| run: | | |
| echo "# :tada: Pull Request created! :tada:" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| echo "Pull request ${{ steps.cpr.outputs.pull-request-number }} was successfully ${{ steps.cpr.outputs.pull-request-operation }}." | |
| echo ":link: [${{ steps.cpr.outputs.pull-request-url }}](${{ steps.cpr.outputs.pull-request-url }})." >> $GITHUB_STEP_SUMMARY | |
| echo "Head SHA: [${{ steps.cpr.outputs.pull-request-head-sha }}](${{ steps.cpr.outputs.pull-request-url }}/commits/${{ steps.cpr.outputs.pull-request-head-sha }})." >> $GITHUB_STEP_SUMMARY |