🎨 theme update #499
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
| # Workflow to build and deploy site to Vercel using Hugo | |
| # Name of Workflow | |
| name: deploy-preview | |
| # Controls when the action will run. Triggers the workflow on push | |
| # events but only for the vercel-dev branch | |
| on: | |
| push: | |
| branches: [develop] | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains two jobs called "deploy-preview" and "docsearch-scrape" | |
| deploy-preview: | |
| # The environment this job references | |
| environment: | |
| name: Preview | |
| url: ${{ steps.vercel-action.outputs.preview-url }} | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-22.04 | |
| # Job outputs | |
| outputs: | |
| docs: ${{ steps.filter.outputs.docs }} | |
| docsearch_config: ${{ steps.filter.outputs.config }} | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive # Fetch submodules | |
| fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod | |
| # Step 2 Detect changes to Docs Content | |
| - name: Detect changes in doc content | |
| uses: dorny/paths-filter@v2 | |
| id: filter | |
| with: | |
| filters: | | |
| docs: | |
| - 'content/docs/**' | |
| config: | |
| - 'docsearch-preview.json' | |
| base: develop | |
| # Step 3 - Install Hugo (specific version) | |
| - name: Install Hugo | |
| uses: peaceiris/actions-hugo@v2 | |
| with: | |
| hugo-version: "0.118.2" | |
| extended: true | |
| # Step 4 - Builds the site using Hugo | |
| - name: Build | |
| run: hugo -v -D -e staging | |
| env: | |
| # HUGO_PARAMS_DOCSEARCH_indexName: ${{ secrets.ALGOLIA_INDEX_NAME }} | |
| HUGO_PARAMS_DOCSEARCH_appID: ${{ vars.DOCSEARCH_APPID }} | |
| HUGO_PARAMS_DOCSEARCH_apiKey: ${{ vars.DOCSEARCH_APIKEY }} | |
| HUGO_PARAMS_DOCSEARCH_indexName: ${{ vars.DOCSEARCH_INDEXNAME }} | |
| HUGO_PARAMS_PLAUSIBLE_dataDomain: ${{ secrets.PLAUSIBLE_DOMAIN }} | |
| HUGO_GOOGLEANALYTICS: ${{ vars.HUGO_GOOGLEANALYTICS }} | |
| # Step 5 - Push our generated site to Vercel | |
| - name: Deploy to Vercel | |
| uses: amondnet/vercel-action@v25 | |
| id: vercel-action | |
| with: | |
| vercel-token: ${{ secrets.VERCEL_TOKEN }} # Required | |
| #github-token: ${{ secrets.GITHUB_TOKEN }} #Optional | |
| vercel-org-id: ${{ secrets.VERCEL_ORG_ID }} #Required | |
| vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }} #Required | |
| github-comment: false | |
| #vercel-args: '--prod' #Optional | |
| vercel-args: "--local-config ../vercel.json" #Optional | |
| working-directory: public | |
| alias-domains: | #Optional | |
| lotusdocs-staging.vercel.app | |
| docsearch-scrape: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-20.04 | |
| needs: [deploy-preview] | |
| # Run job only if there are changes to 'content/docs/**' or 'docsearch-preview.json' | |
| if: | | |
| needs.deploy-preview.outputs.docs == 'true' || | |
| needs.deploy-preview.outputs.docsearch_config == 'true' | |
| steps: | |
| # Step 1 - Checks-out your repository under $GITHUB_WORKSPACE | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| # Step 2 - Format and output DocSearch config | |
| - name: Output formatted docsearch-*.json as config | |
| id: docsearch-config | |
| # run: echo "::set-output name=config::$(cat docsearch-preview.json | jq -r tostring)" | |
| run: echo "config=$(cat docsearch-preview.json | jq -r tostring)" >> $GITHUB_OUTPUT | |
| # Step 3 - Update DocSearch Index (only if content files were changed) | |
| - name: Algolia DocSearch Crawl & Index | |
| id: docsearch-scrape | |
| uses: adapttive/algolia-docsearch-action@1.1.1 | |
| env: | |
| APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }} | |
| API_KEY: ${{ secrets.ALGOLIA_ADMIN_API_KEY }} | |
| CONFIG: ${{ steps.docsearch-config.outputs.config }} |