stellar/js-stellar-base

View on GitHub
.github/workflows/gh_pages.yml

Summary

Maintainability
Test Coverage
name: Github Pages
on:
  release:
    types: [published]

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Install Node (18.x)
        uses: actions/setup-node@v3
        with:
          node-version: 18

      - name: Install Dependencies
        run: yarn install

      - name: Build & Test
        run: yarn preversion

      - name: Checkout GH pages
        uses: actions/checkout@v3
        with:
          repository: stellar/js-stellar-base
          ref: gh-pages
          path: jsdoc

      - name: Generate JS docs
        # because parsing errors still result in renderable docs
        continue-on-error: true
        run: yarn docs

      - name: Publish JS docs
        run: |
          TAG=`git describe --tags`
          cd jsdoc
          git config user.name github-actions
          git config user.email github-actions@github.com
          git add .
          git commit -m $TAG
          git push origin gh-pages