ON-34586 # Added CI job for building docs

.github/workflows/release.yml

@@ -16,6 +16,23 @@ jobs:
           PRE_RELEASE: 'false'
           CHANGELOG_FILE: 'CHANGELOG.md'
           ALLOW_EMPTY_CHANGELOG: 'false'
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+      - run: npm install --global npm@8
+      - run: npm ci
+      - run: npm run docs
+      - uses: devops-infra/action-commit-push@v0.9.2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          commit_prefix: '[DOCS] '
+          commit_message: ${{ github.ref_name }}
+          target_branch: 'master'
   publish:
     name: NPM Publish
     runs-on: ubuntu-latest

.github/workflows/test.yml

@@ -1,6 +1,11 @@
 name: Test
 
-on: [push]
+on:
+  push:
+    branches-ignore:
+      - 'master'
+    tags-ignore:
+      - '**'
 
 jobs:
   Test:

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- CI job for building docs
+
 ## [4.1.0] - 2023-08-29
 
 ### Added

CONTRIBUTING.md

@@ -30,10 +30,10 @@ This code base is written in [TypeScript](https://www.typescriptlang.org/) so it
 
 ## Release Process
 
-1. Checkout `main`
+1. Checkout `master`
 
    ```
-   git checkout main
+   git checkout master
    ```
 
 1. Get the latest code

DOCUMENTATION.md

@@ -2,7 +2,7 @@
 
 ## Requirements
 
-- [Node.js](https://nodejs.org/) 12.0 or newer
+- [Node.js](https://nodejs.org/) 16.0 or newer
 - NPM 8.0 or newer
 
 ## Installation

package.json

@@ -8,7 +8,7 @@
   },
   "devDependencies": {
     "@microsoft/eslint-plugin-sdl": "^0.2.0",
-    "@oneblink/release-cli": "^2.0.2",
+    "@oneblink/release-cli": "^2.0.3",
     "@oneblink/types": "github:oneblink/types",
     "@types/jest": "^29.5.0",
     "@typescript-eslint/eslint-plugin": "^5.58.0",
@@ -56,10 +56,10 @@
     "format": "prettier --write .",
     "prepare": "npm run build",
     "pretest": "npm run fixpack && npm run eslint",
-    "release": "typedoc && oneblink-release --no-name",
+    "release": "oneblink-release --no-name",
     "start": "tsc-watch",
     "test": "jest",
     "types": "npm install --save-dev github:oneblink/types",
     "typescript": "tsc --noEmit"
   }
-}
+}