Repository navigation
fix: resolve GitHub Actions wp-hooks-documentor PATH issue #3
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: Deploy to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| schedule: | |
| # Run weekly on Sundays at midnight UTC | |
| - cron: '0 0 * * 0' | |
| workflow_dispatch: # Allow manual trigger | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: '20' | |
| cache: 'npm' | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Install wp-hooks-documentor | |
| run: | | |
| npm install -g github:GravityKit/wp-hooks-documentor | |
| # Add npm global bin to PATH for subsequent steps | |
| echo "$(npm config get prefix)/bin" >> $GITHUB_PATH | |
| - name: Verify wp-hooks-documentor installation | |
| run: wp-hooks-documentor --version || wp-hooks-documentor --help || echo "Tool installed but may not support --version flag" | |
| - name: Clone GravityKit repositories | |
| run: npm run repos:clone | |
| env: | |
| # GH_TOKEN needs read access to GravityKit private repos | |
| GH_TOKEN: ${{ secrets.GK_REPOS_TOKEN }} | |
| - name: Generate hooks documentation | |
| run: npm run docs:generate | |
| - name: Enhance documentation for LLMs | |
| run: npm run llm:enhance | |
| - name: Build site | |
| run: npm run build | |
| env: | |
| # Algolia DocSearch configuration (optional) | |
| ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }} | |
| ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }} | |
| ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }} | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: build | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |