-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
33 changed files
with
1,446 additions
and
1,168 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
name: typespec-compile-and-deploy-gh-pages | ||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
compile: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- name: checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: "20" | ||
|
||
- name: Install typespec | ||
run: npm install -g @typespec/compiler | ||
|
||
- name: Cache npm modules | ||
uses: actions/cache@v4 | ||
with: | ||
path: node_modules | ||
key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }} | ||
restore-keys: | | ||
${{ runner.os }}-node- | ||
- name: Install node_modules | ||
run: npm ci | ||
|
||
- name: Compile typespec | ||
run: tsp compile . | ||
|
||
- name: Install redocly-cli | ||
uses: ./.github/actions/install-redocly-cli | ||
|
||
- name: Build docs | ||
run: redocly build-docs tsp-output/@typespec/openapi3/openapi.yaml -o ./docs/index.html -t ./.github/template.hbs | ||
|
||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: ./docs | ||
|
||
deploy-github-pages: | ||
needs: compile | ||
permissions: | ||
pages: write | ||
id-token: write | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,32 @@ | ||
name: Lint OpenAPI | ||
name: Lint Typespec OpenAPI Definitions | ||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
workflow_call: | ||
push: | ||
|
||
jobs: | ||
lint-definitions: | ||
name: Lint OpenAPI definitions | ||
runs-on: ubuntu-latest | ||
check-format: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Install redocly-cli | ||
uses: ./.github/actions/install-redocly-cli | ||
- name: Lint OpenAPI yml | ||
run: redocly lint ./schema/openapi.yml | ||
lint-examples: | ||
name: Lint OpenAPI examples | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Install redocly-cli | ||
uses: ./.github/actions/install-redocly-cli | ||
- name: Bundle OpenAPI yml | ||
run: redocly bundle ./schema/openapi.yml -o ./bundled-openapi.yml | ||
- name: Install openapi-examples-validator | ||
run: npm install -g openapi-examples-validator | ||
- name: Lint examples | ||
run: openapi-examples-validator ./bundled-openapi.yml | ||
- name: checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: "20" | ||
|
||
- name: Install typespec | ||
run: npm install -g @typespec/compiler | ||
|
||
- name: Cache npm modules | ||
uses: actions/cache@v4 | ||
with: | ||
path: node_modules | ||
key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }} | ||
restore-keys: | | ||
${{ runner.os }}-node- | ||
- name: Install node_modules | ||
run: npm ci | ||
|
||
- name: Check format | ||
run: tsp format --check "**/*.tsp" |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
.idea | ||
docs | ||
node_modules | ||
**/tsp-output |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
#!/bin/bash | ||
|
||
redocly build-docs /schema/openapi.yml -o ./docs/index.html -t ./template.hbs | ||
tsp compile . | ||
|
||
redocly build-docs ./tsp-output/@typespec/openapi3/openapi.yaml -o ./docs/index.html -t ./template.hbs | ||
http-server ./docs -p $PORT |
Oops, something went wrong.