typescript-sdk/.github/workflows/main.yml at c8ea38b7a588000247462ec4940ad53986bf6fe3 · modelcontextprotocol/typescript-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
on:
    push:
        branches:
            - main
    pull_request:
    workflow_dispatch:
    release:
        types: [published]

concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true

jobs:
    build:
        runs-on: ubuntu-latest

        steps:
            - uses: actions/checkout@v6

            - name: Install pnpm
              uses: pnpm/action-setup@v4
              id: pnpm-install
              with:
                  run_install: false
            - uses: actions/setup-node@v6
              with:
                  node-version: 24
                  cache: pnpm
                  cache-dependency-path: pnpm-lock.yaml

            - run: pnpm install
            - run: pnpm run check:all
            - run: pnpm run build:all

    test:
        runs-on: ubuntu-latest
        strategy:
            fail-fast: false
            matrix:
                node-version: [20, 22, 24]

        steps:
            - uses: actions/checkout@v6

            - name: Install pnpm
              uses: pnpm/action-setup@v4
              id: pnpm-install
              with:
                  run_install: false
            - uses: actions/setup-node@v6
              with:
                  node-version: ${{ matrix.node-version }}
                  cache: pnpm
                  cache-dependency-path: pnpm-lock.yaml

            - run: pnpm install

            - run: pnpm test:all

    publish:
        runs-on: ubuntu-latest
        if: github.event_name == 'release'
        environment: release
        needs: [build, test]

        permissions:
            contents: read
            id-token: write

        steps:
            - uses: actions/checkout@v4

            - name: Install pnpm
              uses: pnpm/action-setup@v4
              id: pnpm-install
              with:
                  run_install: false
            - uses: actions/setup-node@v4
              with:
                  node-version: 24
                  cache: pnpm
                  cache-dependency-path: pnpm-lock.yaml
                  registry-url: 'https://registry.npmjs.org'
            - run: pnpm install

            - name: Determine npm tag
              id: npm-tag
              run: |
                  VERSION=$(node -p "require('./package.json').version")
                  # Check if this is a beta release
                  if [[ "$VERSION" == *"-beta"* ]]; then
                    echo "tag=--tag beta" >> $GITHUB_OUTPUT
                  # Check if this release is from a non-main branch (patch/maintenance release)
                  elif [[ "${{ github.event.release.target_commitish }}" != "main" ]]; then
                    # Use "release-X.Y" as tag for old branch releases (e.g., "release-1.23" for 1.23.x)
                    # npm tags are mutable pointers to versions (like "latest" pointing to 1.24.3).
                    # Using "release-1.23" means users can `npm install @modelcontextprotocol/sdk@release-1.23`
                    # to get the latest patch on that minor version, and the tag updates if we
                    # release 1.23.2, 1.23.3, etc.
                    # Note: Can't use "v1.23" because npm rejects tags that look like semver ranges.
                    MAJOR_MINOR=$(echo "$VERSION" | cut -d. -f1,2)
                    echo "tag=--tag release-${MAJOR_MINOR}" >> $GITHUB_OUTPUT
                  else
                    echo "tag=" >> $GITHUB_OUTPUT
                  fi

            - run: pnpm publish --provenance --access public ${{ steps.npm-tag.outputs.tag }}
              env:
                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

    # Generates API documentation for GitHub Pages on any release
    # Supports both simple tags (v1.2.3) and package-scoped tags (@scope/package@1.2.3)
    publish-gh-pages:
        runs-on: ubuntu-latest
        if: github.event_name == 'release'
        needs: [publish]

        permissions:
            contents: write

        steps:
            - uses: actions/checkout@v4
              with:
                  fetch-depth: 0 # Fetch all history for all branches and tags

            - name: Install pnpm
              uses: pnpm/action-setup@v4
              with:
                  run_install: false
            - uses: actions/setup-node@v4
              with:
                  node-version: 24
                  cache: pnpm
                  cache-dependency-path: pnpm-lock.yaml

            - name: Install dependencies
              run: pnpm install

            - name: Configure Git
              run: |
                  git config --global user.name "github-actions[bot]"
                  git config --global user.email "github-actions[bot]@users.noreply.github.com"

            - name: Generate documentation
              run: ./scripts/generate-gh-pages.sh "${{ github.ref_name }}"

            - name: Push to gh-pages
              run: git push origin gh-pages