Skip to content

Commit 906108d

Browse files
authored
Add Redocly to docs (#1134)
* Add Redocly to docs * Fix Actions YAML
1 parent fb2b493 commit 906108d

File tree

3 files changed

+26
-26
lines changed

3 files changed

+26
-26
lines changed

.github/workflows/release.yml

+24-24
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Release
1+
name: release
22

33
on:
44
push:
@@ -9,26 +9,26 @@ jobs:
99
changelog:
1010
name: Changelog PR or Release
1111
runs-on: ubuntu-latest
12-
steps:
13-
- uses: actions/checkout@v3
14-
- uses: pnpm/action-setup@v2
15-
with:
16-
version: 8
17-
- name: Setup Node
18-
uses: actions/setup-node@v3
19-
with:
20-
node-version: 20
21-
- run: pnpm i
22-
- run: pnpm run build
23-
- name: Create Release Pull Request or Publish
24-
id: changesets
25-
uses: changesets/action@v1
26-
with:
27-
version: pnpm run version
28-
publish: pnpm exec changeset publish
29-
commit: "[ci] release"
30-
title: "[ci] release"
31-
env:
32-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33-
# npm token temporarily disabled for debugging
34-
# NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: pnpm/action-setup@v2
15+
with:
16+
version: 8
17+
- name: Setup Node
18+
uses: actions/setup-node@v3
19+
with:
20+
node-version: 20
21+
- run: pnpm i
22+
- run: pnpm run build
23+
- name: Create Release Pull Request or Publish
24+
id: changesets
25+
uses: changesets/action@v1
26+
with:
27+
version: pnpm run version
28+
publish: pnpm exec changeset publish
29+
commit: "[ci] release"
30+
title: "[ci] release"
31+
env:
32+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33+
# npm token temporarily disabled for debugging
34+
# NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

docs/src/content/docs/about.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ description: Additional info about this project
2424

2525
1. Support converting any valid OpenAPI schema to TypeScript types, no matter how complicated.
2626
1. Generate **runtime-free types** for maximum performance.
27-
1. This library does **NOT** validate your schema, there are other libraries for that.
27+
1. This library does **NOT** validate your schema, there existing libraries for that (like [`redocly lint`](https://redocly.com/docs/cli/commands/lint/)).
2828
1. The generated TypeScript types **must** match your schema as closely as possible (e.g. no renaming to `PascalCase`)
2929
1. This library should never require Java, node-gyp, or some other complex environment to work. This should require Node.js and nothing else.
3030
1. This library will never require a running OpenAPI server to work.

packages/openapi-typescript/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ There are many other uses for this besides checking `format`. Because this must
263263

264264
1. Support converting any valid OpenAPI schema to TypeScript types, no matter how complicated.
265265
1. Generate **runtime-free types** for maximum performance.
266-
1. This library does **NOT** validate your schema, there are other libraries for that.
266+
1. This library does **NOT** validate your schema, there existing libraries for that (like [`redocly lint`](https://redocly.com/docs/cli/commands/lint/)).
267267
1. The generated TypeScript types **must** match your schema as closely as possible (e.g. no renaming to `PascalCase`)
268268
1. This library should never require Java, node-gyp, or some other complex environment to work. This should require Node.js and nothing else.
269269
1. This library will never require a running OpenAPI server to work.

0 commit comments

Comments
 (0)