[Backport release_3_9] Fix typo and JS lint #1690
Workflow file for this run
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: 📖 Documentation | |
| on: | |
| push: | |
| # tags: | |
| # - '*' | |
| branches: | |
| - master | |
| pull_request: | |
| branches: | |
| - master | |
| - release_3_* | |
| workflow_dispatch: | |
| permissions: | |
| id-token: write | |
| pages: write | |
| jobs: | |
| jsdoc: | |
| name: "🟨 JS-Doc" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 21 | |
| - name: Building JS docs | |
| run: make js-doc | |
| - uses: actions/upload-artifact@master | |
| with: | |
| name: js | |
| path: docs/js/assets/1.0.0/ | |
| phpdoc: | |
| name: "🐘 PHP-Doc" | |
| if: github.repository == '3liz/lizmap-web-client' && github.ref == 'refs/heads/master' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - name: Building PHP docs | |
| run: make php-doc | |
| - uses: actions/upload-artifact@master | |
| with: | |
| name: php | |
| path: docs/php | |
| deploy: | |
| needs: [ jsdoc, phpdoc ] | |
| name: "📤 Deploy" | |
| if: github.repository == '3liz/lizmap-web-client' && github.ref == 'refs/heads/master' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@master | |
| with: | |
| name: php | |
| path: docs/php/ | |
| - uses: actions/download-artifact@master | |
| with: | |
| name: js | |
| path: docs/js/ | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/ | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |
| # - name: Branch name | |
| # id: branch-name | |
| # run: make debug | grep SHORT_VERSION= >> "$GITHUB_OUTPUT" | |
| # | |
| # - name: Install multi deploy version | |
| # run: npm i @koumoul/gh-pages-multi | |
| # | |
| # - name: Token | |
| # env: | |
| # GITHUB_TOKEN: ${{ secrets.TOKEN_TEST }} | |
| # run: git remote set-url origin https://${{ secrets.TOKEN_TEST }}@github.com/Gustry/lizmap-web-client.git | |
| # | |
| # - name: Deploy build | |
| # env: | |
| # BRANCH_NAME: ${{ steps.branch-name.outputs.SHORT_VERSION }} | |
| # run: | | |
| # git config --global user.name "Bot" | |
| # git config --global user.email "[email protected]" | |
| # ./node_modules/.bin/gh-pages-multi deploy -s docs/js/assets/1.0.0/ -t $BRANCH_NAME -v | |
| - name: Summary | |
| run: | | |
| echo " | |
| ### Published ! :rocket: | |
| [Visit the doc](https://docs.3liz.org/lizmap-web-client/) | |
| " >> $GITHUB_STEP_SUMMARY |