docs: add github action as recommended usage method (#4716) #1
This file contains hidden or 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: Generate Theme Readme | |
| on: | |
| push: | |
| branches: | |
| - master | |
| paths: | |
| - "themes/index.js" | |
| workflow_dispatch: | |
| permissions: | |
| actions: read | |
| checks: read | |
| contents: write | |
| deployments: read | |
| issues: read | |
| discussions: read | |
| packages: read | |
| pages: read | |
| pull-requests: read | |
| repository-projects: read | |
| security-events: read | |
| statuses: read | |
| jobs: | |
| generateThemeDoc: | |
| runs-on: ubuntu-latest | |
| name: Generate theme doc | |
| strategy: | |
| matrix: | |
| node-version: [22.x] | |
| steps: | |
| - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 | |
| - name: Setup Node | |
| uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: npm | |
| # Fix the unsafe repo error which was introduced by the CVE-2022-24765 git patches. | |
| - name: Fix unsafe repo error | |
| run: git config --global --add safe.directory ${{ github.workspace }} | |
| - name: npm install, generate readme | |
| run: | | |
| npm ci | |
| npm run theme-readme-gen | |
| env: | |
| CI: true | |
| - name: Run Script | |
| uses: skx/github-action-tester@e29768ff4ff67be9d1fdbccd8836ab83233bebb1 # v0.10.0 | |
| with: | |
| script: ./scripts/push-theme-readme.sh | |
| env: | |
| CI: true | |
| PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }} | |
| GH_REPO: ${{ secrets.GH_REPO }} |