pipeline improvements

.github/workflows/deploy-docs.yml

@@ -0,0 +1,52 @@
+name: Publish Documentation
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  build-and-deploy:
+    runs-on: self-hosted
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: master
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate docs
+        run: npm run doc
+
+      - name: Extract version
+        id: pkg
+        run: echo "VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_ENV
+
+      - name: Checkout docs branch
+        uses: actions/checkout@v4
+        with:
+          ref: docs
+          clean: false
+
+      - name: Copy docs to root
+        run: |
+          cp -v -r docs/* .
+          rm -rf docs
+
+      - name: Commit and push docs
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "[email protected]"
+          git add .
+          git commit -m "Update documentation for version v${{ env.VERSION }}"
+          git push

.github/workflows/publish.yml

@@ -66,45 +66,7 @@ jobs:
     name: Docs publish
     needs:
       - publish
-    runs-on: self-hosted
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          ref: master
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Generate docs
-        run: npm run doc
-
-      - name: Extract version
-        id: pkg
-        run: echo "VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_ENV
-
-      - name: Checkout docs branch
-        uses: actions/checkout@v4
-        with:
-          ref: docs
-          clean: false
-
-      - name: Copy docs to root
-        run: |
-          cp -r docs/* .
-
-      - name: Commit and push docs
-        run: |
-          git config user.name "GitHub Actions"
-          git config user.email "[email protected]"
-          git add .
-          git commit -m "Update documentation for version v${{ env.VERSION }}"
-          git push
+    uses: MrRefactoring/jira.js/.github/workflows/deploy-docs.yaml@master
 
   creating-git-tag:
     name: Create Git Tag

examples/package.json

@@ -12,9 +12,9 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^20.9.0",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "@types/node": "^20.10.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
     "jira.js": "latest"

src/serviceDesk/parameters/attachTemporaryFile.ts

@@ -1,4 +1,4 @@
-interface Attachment {
+export interface Attachment {
   filename: string;
   file: Buffer | ReadableStream | string | Blob | File;
 }

src/version2/parameters/addAttachment.ts

@@ -1,4 +1,4 @@
-interface Attachment {
+export interface Attachment {
   filename: string;
   file: Buffer | ReadableStream | string | Blob | File;
 }

src/version3/parameters/addAttachment.ts

@@ -1,4 +1,4 @@
-interface Attachment {
+export interface Attachment {
   filename: string;
   file: Buffer | ReadableStream | string | Blob | File;
 }