update_contributors #694
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: update_contributors | |
| # Workflow triggers: | |
| on: | |
| schedule: | |
| # Run the workflow once a day at 2:00 AM UTC: | |
| - cron: '0 2 * * *' | |
| # Allow the workflow to be manually run: | |
| workflow_dispatch: | |
| # Global permissions: | |
| permissions: | |
| # Allow read-only access to the repository contents: | |
| contents: read | |
| # Workflow jobs: | |
| jobs: | |
| # Define a job for updating the contributors list... | |
| update-contributors: | |
| # Define a display name: | |
| name: 'Update contributors' | |
| # Ensure the job does not run on forks: | |
| if: github.repository == 'stdlib-js/stdlib' | |
| # 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 | |
| # Refers to the development branch: | |
| ref: 'develop' | |
| # Fetch entire history: | |
| fetch-depth: 0 | |
| # Specify whether to download Git-LFS files: | |
| lfs: false | |
| timeout-minutes: 10 | |
| # Update the contributors list: | |
| - name: 'Update contributors' | |
| id: update-contributors | |
| run: | | |
| make update-contributors | |
| if [[ -z "$(git status --porcelain)" ]]; then | |
| echo "No changes to commit." | |
| echo "changed=false" >> $GITHUB_OUTPUT | |
| else | |
| echo "changed=true" >> $GITHUB_OUTPUT | |
| fi | |
| # Import GPG key to sign commits: | |
| - name: 'Import GPG key to sign commits' | |
| # Pin action to full length commit SHA | |
| uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.0 | |
| with: | |
| gpg_private_key: ${{ secrets.STDLIB_BOT_GPG_PRIVATE_KEY }} | |
| passphrase: ${{ secrets.STDLIB_BOT_GPG_PASSPHRASE }} | |
| git_user_signingkey: true | |
| git_commit_gpgsign: true | |
| # Create a pull request: | |
| - name: 'Create pull request' | |
| if: steps.update-contributors.outputs.changed == 'true' | |
| # Pin action to full length commit SHA | |
| uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # v7.0.5 | |
| id: cpr | |
| with: | |
| title: 'docs: update list of contributors' | |
| body: | | |
| This PR | |
| - updates the list of contributors | |
| commit-message: 'docs: update list of contributors' | |
| committer: 'stdlib-bot <[email protected]>' | |
| signoff: true | |
| token: ${{ secrets.PULL_REQUEST_TOKEN }} | |
| labels: | | |
| documentation | |
| automated-pr | |
| team-reviewers: | | |
| reviewers | |
| branch: update-contributors | |
| delete-branch: true | |
| # Create a pull request summary: | |
| - 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 |