[COL-526] Update and consolidate docstring comments #1043
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: Build and test | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| audit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: 18 | |
| - run: npm ci | |
| - run: npm audit --production | |
| format-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: 18 | |
| - run: npm ci | |
| - run: npm run format:check | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: 18 | |
| - run: npm ci | |
| - run: npm run lint | |
| test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| submodules: true | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: 18 | |
| - run: npm ci | |
| - run: npm run test | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: 18 | |
| - run: npm ci | |
| - run: npm run build | |
| docs: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| id-token: write | |
| deployments: write | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: 18 | |
| - name: Install Package Dependencies | |
| run: npm ci | |
| - name: Build SDK | |
| run: npm run build | |
| - name: Build Documentation | |
| run: npm run docs | |
| - name: Configure AWS Credentials | |
| uses: aws-actions/configure-aws-credentials@v1 | |
| with: | |
| aws-region: eu-west-2 | |
| role-to-assume: arn:aws:iam::${{ secrets.ABLY_AWS_ACCOUNT_ID_SDK }}:role/ably-sdk-builds-spaces | |
| role-session-name: "${{ github.run_id }}-${{ github.run_number }}" | |
| - name: Upload Documentation | |
| uses: ably/sdk-upload-action@v1 | |
| with: | |
| sourcePath: docs/typedoc/generated | |
| githubToken: ${{ secrets.GITHUB_TOKEN }} | |
| artifactName: typedoc | |
| test-cdn-bundle: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| submodules: true | |
| - uses: actions/setup-node@v1 | |
| with: | |
| node-version: 18 | |
| - run: npm ci | |
| - run: npx playwright install chromium | |
| - run: npm run build | |
| - run: npm run test:cdn-bundle |