feat: jsonpath upgrade, new default module format for ts (#1230) #1105
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: Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| env: | |
| GOPRIVATE: "github.com/speakeasy-api" | |
| jobs: | |
| docs: | |
| name: Documentation | |
| runs-on: ubuntu-latest | |
| env: | |
| CLI_RUNTIME: "docs" | |
| steps: | |
| - name: Checkout speakeasy repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| path: speakeasy | |
| token: ${{ secrets.DOCUMENTATION_PAT }} | |
| - name: Checkout speakeasy-registry repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| repository: speakeasy-api/speakeasy-registry | |
| path: speakeasy-registry | |
| token: ${{ secrets.DOCUMENTATION_PAT }} | |
| - name: Configure git for private modules | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.BOT_REPO_TOKEN }} | |
| run: git config --global url."https://speakeasybot:${GITHUB_TOKEN}@github.com".insteadOf "https://github.com" | |
| - name: Set up Go 1.x | |
| uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0 | |
| with: | |
| go-version-file: "speakeasy/go.mod" | |
| - name: Generate speakeasy cli docs | |
| working-directory: speakeasy | |
| run: | | |
| go run cmd/docs/main.go | |
| - name: Generate speakeasy-registry doc-site docs | |
| working-directory: speakeasy | |
| run: | | |
| go run cmd/docs/main.go -out-dir ../speakeasy-registry/web/packages/marketing-site/src/pages/docs/speakeasy-reference/cli -doc-site | |
| - name: Create PR against speakeasy-registry | |
| uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6 | |
| with: | |
| path: speakeasy-registry | |
| token: ${{ secrets.DOCUMENTATION_PAT }} | |
| commit-message: "docs: update speakeasy cli docs" | |
| title: "docs: update speakeasy cli docs" | |
| - if: failure() | |
| name: Notify Slack on Failure | |
| uses: slackapi/slack-github-action@485a9d42d3a73031f12ec201c457e2162c45d02d # v2.0.0 | |
| with: | |
| webhook: ${{ secrets.SLACK_DOCS_WEBHOOK_URL }} # URL for docs channel | |
| webhook-type: incoming-webhook | |
| payload: | | |
| text: "*CLI to Website Documentation Failure*:" | |
| blocks: | |
| - type: "section" | |
| text: | |
| type: "mrkdwn" | |
| text: "*GitHub Actions Logs*: <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|View Logs>" |