reduce noise from doc generation (#600)

✅ Closes: #598

.github/workflows/pull-request-release.yml

@@ -12,34 +12,6 @@ permissions:
   pull-requests: write
 
 jobs:
-  generate_docs:
-    name: Generate Docs
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.DOCUMENTATION_GITHUB_TOKEN }}
-          ref: ${{ github.head_ref }}
-      - name: Extract node version from package.json
-        uses: sergeysova/jq-action@v2
-        id: node_version
-        with:
-          cmd: jq .engines.node package.json -r | sed -e 's/"//g' | sed -e 's/>=//g'
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '${{ steps.node_version.outputs.value }}'
-      - name: Use Yarn
-        run: corepack enable
-      - name: Install deps
-        run: yarn
-      - name: Generate Docs
-        run: yarn run docs/generate
-      - uses: stefanzweifel/git-auto-commit-action@v5
-        with:
-          commit_message: "[skip ci] docs: automated update to docs\n\nskip-checks: true"
-          file_pattern: 'docs/**'
-
   unit_tests_linux:
     name: Verify PR - Tests (Linux)
     runs-on: ubuntu-latest

.github/workflows/verify-commits.yml

@@ -11,6 +11,36 @@ permissions:
   contents: read
 
 jobs:
+  generate_docs:
+    name: Generate Docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.DOCUMENTATION_GITHUB_TOKEN }}
+          ref: ${{ github.head_ref }}
+      - name: Extract node version from package.json
+        uses: sergeysova/jq-action@v2
+        id: node_version
+        with:
+          cmd: jq .engines.node package.json -r | sed -e 's/"//g' | sed -e 's/>=//g'
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '${{ steps.node_version.outputs.value }}'
+      - name: Use Yarn
+        run: corepack enable
+      - name: Install deps
+        run: yarn
+      - name: Generate Docs
+        run: yarn run docs/generate
+      - name: Ignore mode changes
+        run: git config --global core.fileMode false
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "[skip ci] docs: automated update to docs\n\nskip-checks: true"
+          file_pattern: 'docs/**'
+
   unit_tests_linux:
     name: Verify Tests (Linux)
     runs-on: ubuntu-latest

.husky/prepare-commit-msg

@@ -7,6 +7,4 @@ if [ -d "$GIT_DIRECTORY"/rebase-apply ]; then
   exit 0
 fi
 
-if [ -d /dev/tty ]; then
-  exec </dev/tty && yarn dlx git-cz --hook || true
-fi
+exec </dev/tty && yarn dlx git-cz --hook || true

changelog.config.js

@@ -23,7 +23,7 @@ module.exports = {
     'issues',
     'lerna',
   ],
-  scopes: ['api', 'ui', 'extension', 'updater', 'misc'],
+  scopes: ['api', 'ui', 'ext', 'updater', 'misc'],
   types: {
     chore: {
       description: 'Build process or auxiliary tool changes',

docs/types.entities/type-aliases/CompletionStatus.md

@@ -26,4 +26,4 @@ Completion statuses are used to describe a player's progress in a game.
 
 ## Defined in
 
-[types.entities.ts:184](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L184)
+[types.entities.ts:184](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L184)

docs/types.entities/type-aliases/Entity.md

@@ -12,4 +12,4 @@ Supported entities.
 
 ## Defined in
 
-[types.entities.ts:96](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L96)
+[types.entities.ts:96](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L96)

docs/types.entities/type-aliases/Game.md

@@ -41,4 +41,4 @@ A game may have multiple releases across different platforms and sources.
 
 ## Defined in
 
-[types.entities.ts:220](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L220)
+[types.entities.ts:220](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L220)

docs/types.entities/type-aliases/GameAsset.md

@@ -34,4 +34,4 @@ Game assets are used to associate images with entities.
 
 ## Defined in
 
-[types.entities.ts:327](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L327)
+[types.entities.ts:327](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L327)

docs/types.entities/type-aliases/GameAssetType.md

@@ -22,4 +22,4 @@ Game asset types represent the types of game assets that can be associated with
 
 ## Defined in
 
-[types.entities.ts:317](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L317)
+[types.entities.ts:317](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L317)

docs/types.entities/type-aliases/GameFeature.md

@@ -26,4 +26,4 @@ Features are used to describe a game's characteristics.
 
 ## Defined in
 
-[types.entities.ts:162](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L162)
+[types.entities.ts:162](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L162)

docs/types.entities/type-aliases/GameSource.md

@@ -26,4 +26,4 @@ Sources are used to describe where a game was obtained.
 
 ## Defined in
 
-[types.entities.ts:206](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L206)
+[types.entities.ts:206](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L206)

docs/types.entities/type-aliases/Genre.md

@@ -26,4 +26,4 @@ Genres are used to categorize games by their game play characteristics.
 
 ## Defined in
 
-[types.entities.ts:173](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L173)
+[types.entities.ts:173](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L173)

docs/types.entities/type-aliases/Identifiable.md

@@ -18,4 +18,4 @@ Foundation of all data entities; all data entities have an ID.
 
 ## Defined in
 
-[types.entities.ts:4](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L4)
+[types.entities.ts:4](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L4)

docs/types.entities/type-aliases/Platform.md

@@ -60,4 +60,4 @@ Platforms are used to categorize games by the system they are played on. Note a
 
 ## Defined in
 
-[types.entities.ts:116](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L116)
+[types.entities.ts:116](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L116)

docs/types.entities/type-aliases/Playlist.md

@@ -36,4 +36,4 @@ Playlists are used to group games together for easy access. A playlist consists
 
 ## Defined in
 
-[types.entities.ts:299](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L299)
+[types.entities.ts:299](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L299)

docs/types.entities/type-aliases/Release.md

@@ -152,4 +152,4 @@ A release is a specific version of a game that is available on a platform and so
 
 ## Defined in
 
-[types.entities.ts:255](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L255)
+[types.entities.ts:255](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L255)

docs/types.entities/type-aliases/RunState.md

@@ -22,4 +22,4 @@ Run states are used to describe the current state of a game's process.
 
 ## Defined in
 
-[types.entities.ts:247](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L247)
+[types.entities.ts:247](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L247)

docs/types.entities/type-aliases/Series.md

@@ -32,4 +32,4 @@ The "Assassin's Creed" series would include all games in the "Assassin's Creed"
 
 ## Defined in
 
-[types.entities.ts:151](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L151)
+[types.entities.ts:151](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L151)

docs/types.entities/type-aliases/Tag.md

@@ -26,4 +26,4 @@ Tags are used to categorize games by their characteristics.
 
 ## Defined in
 
-[types.entities.ts:195](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L195)
+[types.entities.ts:195](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L195)

docs/types.entities/type-aliases/User.md

@@ -34,4 +34,4 @@ Users are used to authenticate and authorize access to the application.
 
 ## Defined in
 
-[types.entities.ts:340](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L340)
+[types.entities.ts:340](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L340)

docs/types.entities/variables/runStates.md

@@ -12,4 +12,4 @@ Possible run state values.
 
 ## Defined in
 
-[types.entities.ts:231](https://github.com/andrew-codes/playnite-web/blob/b159d1f96feee4620c5fbc9157a5493b48d2f672/apps/playnite-web/src/server/data/types.entities.ts#L231)
+[types.entities.ts:231](https://github.com/andrew-codes/playnite-web/blob/main/apps/playnite-web/src/server/data/types.entities.ts#L231)

typedoc.json

@@ -11,5 +11,6 @@
   ],
   "exclude": [],
   "readme": "none",
-  "out": "./docs"
+  "out": "./docs",
+  "gitRevision": "main"
 }