Skip to content

Commit ebbdf25

Browse files
ianhodgeianhodge
authored
Merge pull request #1 from warpdotdev/release-please--branches--main--changes--next--components--warp-sdk
release: 0.1.0
2 parents a0a3a96 + 4175bac commit ebbdf25

11 files changed

Lines changed: 185 additions & 12 deletions

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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/warpdotdev/warp-sdk-typescript/actions/workflows/publish-npm.yml
4+
name: Publish NPM
5+
on:
6+
workflow_dispatch:
7+
8+
release:
9+
types: [published]
10+
11+
jobs:
12+
publish:
13+
name: publish
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Set up Node
20+
uses: actions/setup-node@v3
21+
with:
22+
node-version: '20'
23+
24+
- name: Set up pnpm
25+
uses: pnpm/action-setup@v4
26+
27+
- name: Install dependencies
28+
run: |
29+
pnpm install
30+
31+
- name: Publish to NPM
32+
run: |
33+
bash ./bin/publish-npm
34+
env:
35+
NPM_TOKEN: ${{ secrets.WARP_API_NPM_TOKEN || secrets.NPM_TOKEN }}

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Release Doctor
2+
on:
3+
pull_request:
4+
branches:
5+
- main
6+
workflow_dispatch:
7+
8+
jobs:
9+
release_doctor:
10+
name: release doctor
11+
runs-on: ubuntu-latest
12+
if: github.repository == 'warpdotdev/warp-sdk-typescript' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
13+
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Check release environment
18+
run: |
19+
bash ./bin/check-release-environment
20+
env:
21+
NPM_TOKEN: ${{ secrets.WARP_API_NPM_TOKEN || secrets.NPM_TOKEN }}
22+

‎.release-please-manifest.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "0.1.0"
3+
}

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 3
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-bnavetta%2Fwarp-api-c4c5f89f67a73e4d17377d2b96fc201a63cd5458cbebaa23e78f92b59b90cc5b.yml
33
openapi_spec_hash: 931c6189a4fc4ee320963646b1b7edbe
4-
config_hash: d7af3570f723bf4703e5b792bec2a9c6
4+
config_hash: a1f8af77d3fd2148abd3ad8d4dbf20a4

‎CHANGELOG.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
## 0.1.0 (2025-12-15)
4+
5+
Full Changelog: [v0.0.1...v0.1.0](https://github.com/warpdotdev/warp-sdk-typescript/compare/v0.0.1...v0.1.0)
6+
7+
### Features
8+
9+
* **api:** manual updates ([540303c](https://github.com/warpdotdev/warp-sdk-typescript/commit/540303c2ba99574bb60154d7bd0571275cb4f2c6))
10+
* **api:** manual updates ([caf8aea](https://github.com/warpdotdev/warp-sdk-typescript/commit/caf8aea70db2910cf39047dfa607fd8504919bbb))
11+
12+
13+
### Chores
14+
15+
* update SDK settings ([8096174](https://github.com/warpdotdev/warp-sdk-typescript/commit/809617480b9653a93e15ab5b0bec1c2f4164b82e))
16+
* update SDK settings ([23f76a7](https://github.com/warpdotdev/warp-sdk-typescript/commit/23f76a7cc7763be919d488512c055c665ba119cb))

‎CONTRIBUTING.md‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ If you’d like to use the repository from source, you can either install from g
4242
To install via git:
4343

4444
```sh
45-
$ npm install git+ssh://git@github.com:stainless-sdks/warp-api-typescript.git
45+
$ npm install git+ssh://git@github.com:warpdotdev/warp-sdk-typescript.git
4646
```
4747

4848
Alternatively, to link a local copy of the repo:
4949

5050
```sh
5151
# Clone
52-
$ git clone https://www.github.com/stainless-sdks/warp-api-typescript
53-
$ cd warp-api-typescript
52+
$ git clone https://www.github.com/warpdotdev/warp-sdk-typescript
53+
$ cd warp-sdk-typescript
5454

5555
# With yarn
5656
$ yarn link
@@ -91,3 +91,17 @@ To format and fix all lint issues automatically:
9191
```sh
9292
$ pnpm 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/warpdotdev/warp-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: 2 additions & 5 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:stainless-sdks/warp-api-typescript.git
14+
npm install warp-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 warp-sdk`
19-
2017
## Usage
2118

2219
The full API of this library can be found in [api.md](api.md).
@@ -338,7 +335,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con
338335

339336
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
340337

341-
We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/warp-api-typescript/issues) with questions, bugs, or suggestions.
338+
We are keen for your feedback; please open an [issue](https://www.github.com/warpdotdev/warp-sdk-typescript/issues) with questions, bugs, or suggestions.
342339

343340
## Requirements
344341

‎bin/check-release-environment‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#!/usr/bin/env bash
2+
3+
errors=()
4+
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+
9+
lenErrors=${#errors[@]}
10+
11+
if [[ lenErrors -gt 0 ]]; then
12+
echo -e "Found the following errors in the release environment:\n"
13+
14+
for error in "${errors[@]}"; do
15+
echo -e "- $error\n"
16+
done
17+
18+
exit 1
19+
fi
20+
21+
echo "The environment is ready to push releases!"
22+

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
22
"name": "warp-sdk",
3-
"version": "0.0.1",
3+
"version": "0.1.0",
44
"description": "The official TypeScript library for the Warp API API",
55
"author": "Warp API <>",
66
"types": "dist/index.d.ts",
77
"main": "dist/index.js",
88
"type": "commonjs",
9-
"repository": "github:stainless-sdks/warp-api-typescript",
9+
"repository": "github:warpdotdev/warp-sdk-typescript",
1010
"license": "Apache-2.0",
1111
"packageManager": "pnpm@10.24.0",
1212
"files": [

‎release-please-config.json‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"packages": {
3+
".": {}
4+
},
5+
"$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json",
6+
"include-v-in-tag": true,
7+
"include-component-in-tag": false,
8+
"versioning": "prerelease",
9+
"prerelease": true,
10+
"bump-minor-pre-major": true,
11+
"bump-patch-for-minor-pre-major": false,
12+
"pull-request-header": "Automated Release PR",
13+
"pull-request-title-pattern": "release: ${version}",
14+
"changelog-sections": [
15+
{
16+
"type": "feat",
17+
"section": "Features"
18+
},
19+
{
20+
"type": "fix",
21+
"section": "Bug Fixes"
22+
},
23+
{
24+
"type": "perf",
25+
"section": "Performance Improvements"
26+
},
27+
{
28+
"type": "revert",
29+
"section": "Reverts"
30+
},
31+
{
32+
"type": "chore",
33+
"section": "Chores"
34+
},
35+
{
36+
"type": "docs",
37+
"section": "Documentation"
38+
},
39+
{
40+
"type": "style",
41+
"section": "Styles"
42+
},
43+
{
44+
"type": "refactor",
45+
"section": "Refactors"
46+
},
47+
{
48+
"type": "test",
49+
"section": "Tests",
50+
"hidden": true
51+
},
52+
{
53+
"type": "build",
54+
"section": "Build System"
55+
},
56+
{
57+
"type": "ci",
58+
"section": "Continuous Integration",
59+
"hidden": true
60+
}
61+
],
62+
"release-type": "node",
63+
"extra-files": ["src/version.ts", "README.md"]
64+
}

0 commit comments

Comments
 (0)