Skip to content

Commit 5789ed0

Browse files
committed
Fresh TypeScript library as of 2021-09-21
1 parent e2fd8b3 commit 5789ed0

File tree

3 files changed

+53
-1
lines changed

3 files changed

+53
-1
lines changed

.github/workflows/ci.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: CI
2+
on:
3+
workflow_dispatch:
4+
push:
5+
jobs:
6+
build:
7+
runs-on: ubuntu-20.04
8+
steps:
9+
- uses: actions/checkout@v2
10+
- uses: actions/setup-node@v1
11+
with:
12+
node-version: 14.x
13+
- name: Install pnpm
14+
run: npm install --global pnpm
15+
- name: Install dependencies
16+
run: pnpm install
17+
- name: Build the library
18+
run: pnpm run build
19+
- name: Run tests
20+
run: pnpm run test
21+
- name: Generate API documentation
22+
run: pnpm run docs
23+
- name: Publish API report and documentation
24+
uses: stefanzweifel/git-auto-commit-action@v4
25+
with:
26+
commit_message: Update generated files as of ${{ github.sha }}
27+
file_pattern: docs/api etc

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@
1313
"scripts": {
1414
"build": "heft build",
1515
"test": "heft test",
16-
"prepare": "heft build"
16+
"prepare": "heft build",
17+
"docs": "api-documenter markdown --input temp --output docs/api"
1718
},
1819
"devDependencies": {
20+
"@microsoft/api-documenter": "^7.13.52",
1921
"@rushstack/heft": "^0.39.0",
2022
"@rushstack/heft-web-rig": "^0.4.15",
2123
"@types/heft-jest": "^1.0.2"

pnpm-lock.yaml

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

0 commit comments

Comments
 (0)