docs: Polishing up the provider function documentation. #138
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
| --- | |
| # This workflow uses actions that are not certified by GitHub. They are provided | |
| # by a third-party and are governed by separate terms of service, privacy | |
| # policy, and support documentation. | |
| name: Auto-update on push | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| # Declare default permissions as read only. | |
| permissions: read-all | |
| jobs: | |
| update_on_push_job: | |
| runs-on: ubuntu-latest | |
| name: Auto-update on push | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0 | |
| with: | |
| disable-sudo: true | |
| egress-policy: block | |
| allowed-endpoints: > | |
| github.com:443 | |
| objects.githubusercontent.com:443 | |
| registry.npmjs.org:443 | |
| - name: Install Node.js | |
| uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 | |
| with: | |
| node-version: "20" | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Checkout Source | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install git-cliff | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| curl -L \ | |
| -H "Accept: application/vnd.github+json" \ | |
| -H "Authorization: token ${GITHUB_TOKEN}" \ | |
| -H "X-GitHub-Api-Version: 2022-11-28" \ | |
| -o ${{ runner.temp }}/git-cliff.tgz \ | |
| https://github.com/orhun/git-cliff/releases/download/v1.3.1/git-cliff-1.3.1-x86_64-unknown-linux-gnu.tar.gz | |
| tar -zxvf ${{ runner.temp }}/git-cliff.tgz -C "${{ runner.temp }}" | |
| - name: Generate artifacts | |
| run: | | |
| # Generate list of authors | |
| ./scripts/generate-contributors.sh | |
| # Generate CHANGELOG | |
| ${{ runner.temp }}/git-cliff*/git-cliff -o CHANGELOG.md | |
| # Run Markdownlint. Will probably fail. | |
| npm exec markdownlint-cli --ignore=node_modules --ignore=.github --ignore=.templates --fix '**/*.md' || true | |
| # Run Markdownlint. Should succeed this time. | |
| npm exec markdownlint-cli --ignore=node_modules --ignore=.github --ignore=.templates --fix '**/*.md' || true | |
| - name: Git commit if changed | |
| run: | | |
| git config user.name "Ryan Parman (Bot)" | |
| git config user.email "[email protected]" | |
| git add . | |
| git status | grep modified | |
| if [ $? -eq 0 ]; then | |
| git commit -a -m "automation: Updated AUTHORS and CHANGELOG on $(date)." | |
| git push | |
| fi |