feat!: baseline preparations (#1062)

(cherry picked from commit cf074d8)

Author: metcoder95

.github/workflows/backport.yml

@@ -5,6 +5,9 @@ on:
       - closed
       - labeled
 
+permissions: 
+  contents: read
+
 jobs:
   backport:
     permissions:

.github/workflows/benchmarks.yml

@@ -4,6 +4,9 @@ on:
     paths:
       - docs/**
 
+permissions: 
+  contents: read
+
 jobs:
   build:
     permissions:

.github/workflows/docs-test.yml

@@ -5,6 +5,9 @@ on:
     tags:
       - 'v*'
 
+permissions: 
+  contents: read
+
 jobs:
   build:
     if: github.event_name == 'workflow_dispatch' || contains(github.ref, 'v5')

.github/workflows/docs.yml

@@ -10,6 +10,9 @@ on:
 
 name: CI
 
+permissions: 
+  contents: read
+
 jobs:
   lint:
     permissions:

.github/workflows/nodejs.yml

@@ -3,6 +3,9 @@ on:
   schedule:
     - cron: '0 10 * * 0'
 
+permissions: 
+  contents: read
+
 jobs:
   stale:
     permissions:

.github/workflows/stale.yml

@@ -0,0 +1,28 @@
+---
+id: Errors
+sidebar_position: 8
+---
+
+## Errors
+
+The following section aggregates all the error codes thrown from `Piscina` and an explanation of them
+
+### Constructor
+
+All errors thrown by `Piscina` follows are child of `PiscinaError` parent class.
+
+- `name`: (`string`) Name of the error
+- `code`: (`string`) Error code. Prefixed with `PISCINA_ERR_*`
+- `message`: (`string | null`) Summary of the cause of the error
+- `cause`: (`string | null`) Root cause of the error.
+
+### Error Codes
+
+| Code                                | Description                                                                                                                           |
+| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| PISCINA_ERR_ABORT                   | Indicates a task has been aborted. Seek for the `cause` property to find more about the root cause.                                   |
+| PISCINA_ERR_TASK_QUEUE_LIMIT        | Task queue is at limit. No more tasks are being enqueued. Listen to the `drain` and `needsDrain` event to continue submitting tasks   |
+| PISCINA_ERR_THREAD_TERMINATION      | Thread is being terminated.                                                                                                           |
+| PISCINA_ERR_VALIDATION              | Validation for given values has failed. Review the `message` property for more information                                            |
+| PISCINA_ERR_NO_TASK_QUEUE_AVAILABLE | Task queue has been disabled and workers are at full capacity. Listen to `drain` and `needsDrain` events to continue submitting tasks |
+| PISCINA_ERR_CLOSE_TIMEOUT           | Pool has exceeded timeout for closing up. Pool will be destroyed immediately.                                                         |