docs: add JSDoc comments to TS SDK class properties #159
Workflow file for this run
This file contains hidden or 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: Audit Typescript SDK | |
| on: | |
| push: | |
| branches: [main, next] | |
| paths: | |
| - "ts/**" | |
| pull_request: | |
| branches: [main, next] | |
| paths: | |
| - "ts/**" | |
| jobs: | |
| audit: | |
| name: Audit | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: write | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v3 | |
| - name: Setup PNPM | |
| uses: pnpm/action-setup@v4 | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: "20" | |
| - name: Run pnpm audit (production dependencies only) | |
| id: audit | |
| continue-on-error: true | |
| run: pnpm audit --prod > audit-output.txt 2>&1 | |
| - name: Comment on PR if audit failed | |
| if: steps.audit.outcome == 'failure' && github.event_name == 'pull_request' | |
| run: | | |
| { | |
| echo "⚠️ **Security Audit Warning**" | |
| echo "" | |
| echo "The \`pnpm audit --prod\` check found security vulnerabilities in production dependencies." | |
| echo "" | |
| echo "Please review and fix the vulnerabilities. You can try running:" | |
| echo "\`\`\`bash" | |
| echo "pnpm audit --fix --prod" | |
| echo "\`\`\`" | |
| echo "" | |
| echo "<details>" | |
| echo "<summary>Audit output</summary>" | |
| echo "" | |
| echo "\`\`\`" | |
| cat audit-output.txt | |
| echo "\`\`\`" | |
| echo "" | |
| echo "</details>" | |
| } > audit-comment.txt | |
| - name: Post audit comment to PR | |
| if: steps.audit.outcome == 'failure' && github.event_name == 'pull_request' | |
| uses: thollander/[email protected] | |
| with: | |
| file-path: audit-comment.txt | |
| comment-tag: pnpm-audit-security-warning |