Skip to content

Commit eff2ac5

Browse files
committed
docs: replace repo name
1 parent ee8e354 commit eff2ac5

11 files changed

Lines changed: 70 additions & 25 deletions

.github/workflows/build.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: build
2+
3+
on: push
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
- name: Setup Node
11+
uses: actions/setup-node@v4
12+
with:
13+
node-version: "22"
14+
- name: Install dependencies
15+
run: npm install
16+
- name: Build TypeScript
17+
run: npm run build
18+
- name: Commit build changes
19+
id: current_sha
20+
if: ${{ github.ref == 'refs/heads/main' }}
21+
run: |
22+
git config --local user.name "github-actions[bot]"
23+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
24+
git add dist
25+
if git diff --cached --quiet HEAD; then
26+
echo "No changes to commit."
27+
else
28+
git commit -m "chore(build): Update dist [skip ci]"
29+
fi
30+
echo "current_sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT

.github/workflows/test.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: test
2+
3+
on: push
4+
5+
jobs:
6+
test:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
- name: Setup Node
11+
uses: actions/setup-node@v4
12+
with:
13+
node-version: "22"
14+
- name: Install dependencies
15+
run: npm install
16+
- name: Run tests
17+
run: npm run test

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ env:
3838
STAINLESS_ORG: YOUR_ORG
3939
STAINLESS_PROJECT: YOUR_PROJECT
4040
OAS_PATH: YOUR_OAS_PATH
41-
COMMIT_MESSAGE: ${{ github.event.pull_request.title }}
4241

4342
jobs:
4443
preview:
@@ -54,13 +53,12 @@ jobs:
5453
fetch-depth: 2
5554

5655
- name: Run preview builds
57-
uses: stainless-api/build-sdk-action/preview@3fa5f068d05f51899b2903965e0ec395743d005f
56+
uses: stainless-api/upload-openapi-spec-action/preview@v1
5857
with:
5958
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
6059
org: ${{ env.STAINLESS_ORG }}
6160
project: ${{ env.STAINLESS_PROJECT }}
6261
oas_path: ${{ env.OAS_PATH }}
63-
commit_message: ${{ env.COMMIT_MESSAGE }}
6462

6563
merge:
6664
if: github.event.action == 'closed' && github.event.pull_request.merged == true
@@ -75,13 +73,12 @@ jobs:
7573
fetch-depth: 2
7674

7775
- name: Run merge build
78-
uses: stainless-api/build-sdk-action/merge@3fa5f068d05f51899b2903965e0ec395743d005f
76+
uses: stainless-api/upload-openapi-spec-action/merge@v1
7977
with:
8078
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
8179
org: ${{ env.STAINLESS_ORG }}
8280
project: ${{ env.STAINLESS_PROJECT }}
8381
oas_path: ${{ env.OAS_PATH }}
84-
commit_message: ${{ env.COMMIT_MESSAGE }}
8582
```
8683
</details>
8784
@@ -98,16 +95,17 @@ and integration with docs platforms, see the [examples directory](./examples).
9895
9996
This repository provides three GitHub actions.
10097
101-
- `stainless-api/build-sdk-action`: Build SDKs for a Stainless project. For
102-
information about the input parameters, see the [action definition](./action.yml).
98+
- `stainless-api/upload-openapi-spec-action`: Build SDKs for a Stainless
99+
project. For information about the input parameters, see the [action
100+
definition](./action.yml).
103101

104-
- `stainless-api/build-sdk-action/preview`: Preview changes to SDKs introduced
105-
by a pull request. For information about the input parameters, see the
106-
[action definition](./preview/action.yml).
102+
- `stainless-api/upload-openapi-spec-action/preview`: Preview changes to SDKs
103+
introduced by a pull request. For information about the input parameters, see
104+
the [action definition](./preview/action.yml).
107105

108-
- `stainless-api/build-sdk-action/merge`: Merge changes to SDKs from a pull
109-
request. For information about the input parameters, see the
110-
[action definition](./merge/action.yml).
106+
- `stainless-api/upload-openapi-spec-action/merge`: Merge changes to SDKs from
107+
a pull request. For information about the input parameters, see the [action
108+
definition](./merge/action.yml).
111109

112110
### Workflow permissions
113111

examples/pull_request.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
fetch-depth: 2
4949

5050
- name: Run preview builds
51-
uses: stainless-api/build-sdk-action/preview@3fa5f068d05f51899b2903965e0ec395743d005f
51+
uses: stainless-api/upload-openapi-spec-action/preview@v1
5252
with:
5353
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
5454
org: ${{ env.STAINLESS_ORG }}
@@ -76,7 +76,7 @@ jobs:
7676
# against preview/${{ github.head_ref }} to complete, but assuming that
7777
# the preview-sdk job happens before the PR merge, it should be fine.
7878
- name: Run merge build
79-
uses: stainless-api/build-sdk-action/merge@3fa5f068d05f51899b2903965e0ec395743d005f
79+
uses: stainless-api/upload-openapi-spec-action/merge@v1
8080
with:
8181
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
8282
org: ${{ env.STAINLESS_ORG }}

examples/pull_request_mintlify.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jobs:
6060
fetch-depth: 2
6161

6262
- name: Run preview builds
63-
uses: stainless-api/build-sdk-action/preview@3fa5f068d05f51899b2903965e0ec395743d005f
63+
uses: stainless-api/upload-openapi-spec-action/preview@v1
6464
with:
6565
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
6666
org: ${{ env.STAINLESS_ORG }}
@@ -89,7 +89,7 @@ jobs:
8989
# the preview-sdk job happens before the PR merge, it should be fine.
9090
- name: Run merge build
9191
id: build
92-
uses: stainless-api/build-sdk-action/merge@3fa5f068d05f51899b2903965e0ec395743d005f
92+
uses: stainless-api/upload-openapi-spec-action/merge@v1
9393
with:
9494
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
9595
org: ${{ env.STAINLESS_ORG }}

examples/pull_request_readme.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
fetch-depth: 2
5656

5757
- name: Run preview builds
58-
uses: stainless-api/build-sdk-action/preview@3fa5f068d05f51899b2903965e0ec395743d005f
58+
uses: stainless-api/upload-openapi-spec-action/preview@v1
5959
with:
6060
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
6161
org: ${{ env.STAINLESS_ORG }}
@@ -84,7 +84,7 @@ jobs:
8484
# the preview-sdk job happens before the PR merge, it should be fine.
8585
- name: Run merge build
8686
id: build
87-
uses: stainless-api/build-sdk-action/merge@3fa5f068d05f51899b2903965e0ec395743d005f
87+
uses: stainless-api/upload-openapi-spec-action/merge@v1
8888
with:
8989
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
9090
org: ${{ env.STAINLESS_ORG }}

examples/push.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
uses: actions/checkout@v4
4949

5050
- name: Run build
51-
uses: stainless-api/build-sdk-action@3fa5f068d05f51899b2903965e0ec395743d005f
51+
uses: stainless-api/upload-openapi-spec-action@v1
5252
with:
5353
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
5454
org: ${{ env.STAINLESS_ORG }}

examples/push_mintlify.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ jobs:
6161

6262
- name: Run build
6363
id: build
64-
uses: stainless-api/build-sdk-action@3fa5f068d05f51899b2903965e0ec395743d005f
64+
uses: stainless-api/upload-openapi-spec-action@v1
6565
with:
6666
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
6767
org: ${{ env.STAINLESS_ORG }}

examples/push_readme.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ jobs:
5656

5757
- name: Run build
5858
id: build
59-
uses: stainless-api/build-sdk-action@3fa5f068d05f51899b2903965e0ec395743d005f
59+
uses: stainless-api/upload-openapi-spec-action@v1
6060
with:
6161
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
6262
org: ${{ env.STAINLESS_ORG }}

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)