Skip to content

add github action to update doc #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Feb 22, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
add github action to update doc
  • Loading branch information
Yen Truong committed Feb 18, 2022
commit 440647d46081c9968086295c1ae72b6fa810dffc
27 changes: 27 additions & 0 deletions .github/workflows/update_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Check and Update Repo's documenation

on: pull_request

jobs:
tests:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [17.x]

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: npm run build
- name: Update Documentation
uses: EndBug/add-and-commit@v7
with:
message: "Automated update to repo's documentation from github action"
add: '*.md'
push: true
default_author: github_actions
21 changes: 0 additions & 21 deletions .github/workflows/validate_docs.yml

This file was deleted.

6 changes: 3 additions & 3 deletions api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@
*
* DEFAULT VALUE: "warning"
*/
"logLevel": "warning"
"logLevel": "error"

/**
* When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md),
Expand Down Expand Up @@ -328,7 +328,7 @@
*/
"extractorMessageReporting": {
"default": {
"logLevel": "warning"
"logLevel": "error"
// "addToApiReportFile": false
},

Expand All @@ -352,7 +352,7 @@
*/
"tsdocMessageReporting": {
"default": {
"logLevel": "warning"
"logLevel": "error"
// "addToApiReportFile": false
}

Expand Down
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@
],
"scripts": {
"build": "tsc && npm run api-extractor && npm run generate-docs",
"build-ci": "tsc && npm run api-extractor-ci && npm run generate-docs",
"dev": "tsc --watch",
"lint": "eslint .",
"api-extractor": "api-extractor run --local --verbose",
"api-extractor-ci": "api-extractor run --verbose",
"generate-docs": "api-documenter markdown --input-folder temp --output-folder docs && rm -rf temp",
"prepublishOnly": "npm run build",
"test": "jest --passWithNoTests"
Expand Down
17 changes: 0 additions & 17 deletions scripts/validate_docs.sh

This file was deleted.