add github action to update doc (#37)

add a github action to automate a commit for updating docs if it's out of date. The action will run api extractor in local mode to build api report file, and the logLevel is updated to 'error' so api extractor will fail in local mode and action will exit with non-zero code

also update build command to remove lib folder before running tsc and api extractor to ensure there's no old files in lib that may generate errors in local build.

J=SLAP-1902
TEST=auto

made a small change to a file's doc and push to pr. see that a commit is made from github action to update docs.

Author: yen-tt

.github/workflows/update_docs.yml

@@ -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

.github/workflows/validate_docs.yml

@@ -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),
@@ -328,7 +328,7 @@
      */
     "extractorMessageReporting": {
       "default": {
-        "logLevel": "warning"
+        "logLevel": "error"
         // "addToApiReportFile": false
       },
 
@@ -352,7 +352,7 @@
      */
     "tsdocMessageReporting": {
       "default": {
-        "logLevel": "warning"
+        "logLevel": "error"
         // "addToApiReportFile": false
       }
 

api-extractor.json

@@ -10,12 +10,10 @@
     "src"
   ],
   "scripts": {
-    "build": "tsc && npm run api-extractor && npm run generate-docs",
-    "build-ci": "tsc && npm run api-extractor-ci && npm run generate-docs",
+    "build": "rm -rf lib && tsc && npm run api-extractor && 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"

package.json

@@ -1,4 +1,4 @@
 export * from './components';
 export * from './hooks';
 export * from './models';
-export * from './sections';
+export * from './sections';