API to readme #1381
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
| name: API to readme | |
| on: | |
| schedule: | |
| - cron: 31 14 * * 6 | |
| push: | |
| paths: | |
| - src/* | |
| jobs: | |
| update_readme_api: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/[email protected] | |
| - uses: actions/[email protected] | |
| with: | |
| node-version: 22.4.0 | |
| - run: npm ci | |
| - run: npm run docs | |
| - uses: gr2m/create-or-update-pull-request-action@v1 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| path: README.md | |
| title: Sync API into README | |
| branch: readme-api | |
| commit-message: "docs(README): sync API" |