add code from samples repo #303
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: deploy docs | |
| on: | |
| # trigger deployment on every push to main branch | |
| push: | |
| branches: [main] | |
| # trigger deployment manually | |
| workflow_dispatch: | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| # fetch all commits to get last updated time or other git log info | |
| fetch-depth: 0 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v1 | |
| with: | |
| # choose node.js version to use | |
| node-version: '16' | |
| # cache node_modules | |
| # - name: Cache dependencies | |
| # uses: actions/cache@v2 | |
| # id: yarn-cache | |
| # with: | |
| # path: | | |
| # **/node_modules | |
| # key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} | |
| # restore-keys: | | |
| # ${{ runner.os }}-yarn- | |
| # install dependencies if the cache did not hit | |
| - name: Install dependencies | |
| # if: steps.yarn-cache.outputs.cache-hit != 'true' | |
| run: npm install | |
| # run build script | |
| - name: Build VuePress site | |
| run: npm run docs:build | |
| # please check out the docs of the workflow for more details | |
| # @see https://github.com/crazy-max/ghaction-github-pages | |
| - name: Deploy github pages | |
| uses: crazy-max/ghaction-github-pages@v2 | |
| with: | |
| # deploy to gh-pages branch | |
| target_branch: gh_pages | |
| # deploy the default output dir of VuePress | |
| build_dir: dist | |
| env: | |
| # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| upload: | |
| needs: docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| # fetch all commits to get last updated time or other git log info | |
| fetch-depth: 0 | |
| # checkout branch | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: gh_pages | |
| # deploy to ftp | |
| - name: 📂 Deploy to ftp | |
| uses: SamKirkland/FTP-Deploy-Action@4.3.2 | |
| with: | |
| server: ${{ secrets.FTP_SERVER }} | |
| username: f0152dc5 | |
| password: ${{ secrets.FTP_PASSWORD }} | |
| notify_discord: | |
| needs: upload | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: tsickert/discord-webhook@v5.3.0 | |
| with: | |
| webhook-url: ${{ secrets.DEPLOY_DISCORD_WEBHOOK }} | |
| username: "Deploy Docs 🤖" | |
| content: "Docs have been updated → <https://engine.needle.tools/docs/>\n`${{ github.event.head_commit.message }}`" |