Skip to content

Commit ab3abae

Browse files
check README copy (#55)
1 parent 13a92e3 commit ab3abae

File tree

4 files changed

+464
-3
lines changed

4 files changed

+464
-3
lines changed

.github/workflows/test.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ jobs:
1717
- run: npm run format:check
1818
- run: npm run build:packages
1919
- run: npm run gen:examples
20+
- name: Make sure all changes to the root README.md is copied to the main package before diff check
21+
run: cp README.md packages/openapi-typescript-server/README.md
2022
- name: "Make sure there's no uncommitted changes"
21-
run: git diff --exit-code
23+
run: git add -A && git diff --exit-code HEAD
2224
- run: npm run typecheck
2325
- run: npm test

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It works by generating a TypeScript server interface based on your OpenAPI spec
66

77
You provide a concrete implementation that satisfies the interface for each path operation.
88

9-
At runtime, your implementation is converted into HTTP handlers for various frameworks like [Express](./packages/openapi-typescript-server-express/README.md).
9+
At runtime, your implementation is converted into HTTP handlers for various frameworks like [Express](https://github.com/jasonblanchard/openapi-typescript-server/tree/main/packages/openapi-typescript-server).
1010

1111
## Stability
1212

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
"build:packages": "npm run build --workspaces packages/** --if-present",
1717
"pack": "npm run build:packages && npm pack --workspaces packages/** --pack-destination /tmp",
1818
"format:check": "npx prettier . --check",
19-
"format": "npx prettier . --write"
19+
"format": "npx prettier . --write",
20+
"propagate:readme": "cp README.md packages/openapi-typescript-server/README.md"
2021
},
2122
"engines": {
2223
"node": ">=23.6.0"

0 commit comments

Comments
 (0)