Skip to content

Commit 5c3e559

Browse files
stainless-app[bot]stainless-app[bot]
authored
release: 0.1.2 (#3)
* chore: update SDK settings * release: 0.1.2 --------- Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>
1 parent c392f5f commit 5c3e559

File tree

13 files changed

+89
-30
lines changed

13 files changed

+89
-30
lines changed

‎.github/workflows/publish-npm.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# This workflow is triggered when a GitHub release is created.
2+
# It can also be run manually to re-publish to NPM in case it failed for some reason.
3+
# You can run this workflow by navigating to https://www.github.com/et0and/schools-sdk-typescript/actions/workflows/publish-npm.yml
4+
name: Publish NPM
5+
on:
6+
workflow_dispatch:
7+
inputs:
8+
path:
9+
description: The path to run the release in, e.g. '.' or 'packages/mcp-server'
10+
required: true
11+
12+
release:
13+
types: [published]
14+
15+
jobs:
16+
publish:
17+
name: publish
18+
runs-on: ubuntu-latest
19+
permissions:
20+
contents: write
21+
22+
steps:
23+
- uses: actions/checkout@v4
24+
25+
- name: Set up Node
26+
uses: actions/setup-node@v3
27+
with:
28+
node-version: '20'
29+
30+
- name: Install dependencies
31+
run: |
32+
yarn install
33+
34+
- name: Publish to NPM
35+
run: |
36+
if [ -n "${{ github.event.inputs.path }}" ]; then
37+
PATHS_RELEASED='[\"${{ github.event.inputs.path }}\"]'
38+
else
39+
PATHS_RELEASED='[\".\", \"packages/mcp-server\"]'
40+
fi
41+
yarn tsn scripts/publish-packages.ts "{ \"paths_released\": \"$PATHS_RELEASED\" }"
42+
env:
43+
NPM_TOKEN: ${{ secrets.SCHOOLS_NPM_TOKEN || secrets.NPM_TOKEN }}
44+
45+
- name: Upload MCP Server DXT GitHub release asset
46+
run: |
47+
gh release upload ${{ github.event.release.tag_name }} \
48+
packages/mcp-server/schools_sdk_api.mcpb
49+
env:
50+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/release-doctor.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@ jobs:
1818
run: |
1919
bash ./bin/check-release-environment
2020
env:
21+
NPM_TOKEN: ${{ secrets.SCHOOLS_NPM_TOKEN || secrets.NPM_TOKEN }}
2122

‎.release-please-manifest.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
".": "0.1.1"
2+
".": "0.1.2"
33
}

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 11
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/yufugumi%2Fschools-8b2bd24c42e8cbbe595f5ff86d5b647b19c5db3fe7b0b88e89ac62579e87e0b2.yml
33
openapi_spec_hash: 3585f4f3c71183b9e2275426853a1cd2
4-
config_hash: 922170ad50ac6f28eaec9e268efa4a66
4+
config_hash: edb2b3b15ae0cbb490d27ecb51d81e10

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Changelog
22

3+
## 0.1.2 (2025-11-04)
4+
5+
Full Changelog: [v0.1.1...v0.1.2](https://github.com/et0and/schools-sdk-typescript/compare/v0.1.1...v0.1.2)
6+
7+
### Chores
8+
9+
* update SDK settings ([683f8df](https://github.com/et0and/schools-sdk-typescript/commit/683f8df5588bcc68440b0c0374911c4e5323c94d))
10+
311
## 0.1.1 (2025-11-04)
412

513
Full Changelog: [v0.1.0...v0.1.1](https://github.com/et0and/schools-sdk-typescript/compare/v0.1.0...v0.1.1)

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,17 @@ To format and fix all lint issues automatically:
9191
```sh
9292
$ yarn fix
9393
```
94+
95+
## Publishing and releases
96+
97+
Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
98+
the changes aren't made through the automated pipeline, you may want to make releases manually.
99+
100+
### Publish with a GitHub workflow
101+
102+
You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/et0and/schools-sdk-typescript/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
103+
104+
### Publish manually
105+
106+
If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
107+
the environment.

‎README.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,9 @@ It is generated with [Stainless](https://www.stainless.com/).
1111
## Installation
1212

1313
```sh
14-
npm install git+ssh://git@github.com:et0and/schools-sdk-typescript.git
14+
npm install schools-sdk
1515
```
1616

17-
> [!NOTE]
18-
> Once this package is [published to npm](https://www.stainless.com/docs/guides/publish), this will become: `npm install schools-sdk`
19-
2017
## Usage
2118

2219
The full API of this library can be found in [api.md](api.md).

‎bin/check-release-environment‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
errors=()
44

5+
if [ -z "${NPM_TOKEN}" ]; then
6+
errors+=("The NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
7+
fi
8+
59
lenErrors=${#errors[@]}
610

711
if [[ lenErrors -gt 0 ]]; then

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "schools-sdk",
3-
"version": "0.1.1",
3+
"version": "0.1.2",
44
"description": "The official TypeScript library for the Schools API",
55
"author": "Schools <info@yufugumi.com>",
66
"types": "dist/index.d.ts",

‎packages/mcp-server/README.md‎

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,18 @@ It is generated with [Stainless](https://www.stainless.com/).
44

55
## Installation
66

7-
### Building
7+
### Direct invocation
88

9-
Because it's not published yet, clone the repo and build it:
9+
You can run the MCP Server directly via `npx`:
1010

1111
```sh
12-
git clone git@github.com:et0and/schools-sdk-typescript.git
13-
cd schools-sdk-typescript
14-
./scripts/bootstrap
15-
./scripts/build
16-
```
17-
18-
### Running
19-
20-
```sh
21-
# set env vars as needed
2212
export SCHOOLS_API_KEY="My API Key"
2313
export SCHOOLS_ENVIRONMENT="production"
24-
node ./packages/mcp-server/dist/index.js
14+
npx -y schools-sdk-mcp@latest
2515
```
2616

27-
> [!NOTE]
28-
> Once this package is [published to npm](https://www.stainless.com/docs/guides/publish), this will become: `npx -y schools-sdk-mcp`
29-
3017
### Via MCP Client
3118

32-
[Build the project](#building) as mentioned above.
33-
3419
There is a partial list of existing clients at [modelcontextprotocol.io](https://modelcontextprotocol.io/clients). If you already
3520
have a client, consult their documentation to install the MCP server.
3621

@@ -40,8 +25,8 @@ For clients with a configuration JSON, it might look something like this:
4025
{
4126
"mcpServers": {
4227
"schools_sdk_api": {
43-
"command": "node",
44-
"args": ["/path/to/local/schools-sdk-typescript/packages/mcp-server", "--client=claude", "--tools=all"],
28+
"command": "npx",
29+
"args": ["-y", "schools-sdk-mcp", "--client=claude", "--tools=all"],
4530
"env": {
4631
"SCHOOLS_API_KEY": "My API Key",
4732
"SCHOOLS_ENVIRONMENT": "production"

0 commit comments

Comments
 (0)