@devilsdev/rag-pipeline-utils 2.1.3 → 2.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/.github/workflows/docs-ci.yml +21 -9
  2. package/.github/workflows/docs-deploy.yml +27 -12
  3. package/CHANGELOG.md +8 -0
  4. package/docs-site/blog/2025-04-21-release-v2.1.3.md +13 -0
  5. package/package.json +1 -1
package/.github/workflows/docs-ci.yml CHANGED
@@ -1,3 +1,8 @@
1
+ # .github/workflows/docs-ci.yml
2
+ # Version: 1.0.0
3
+ # Description: CI pipeline for linting, testing, and building docs
4
+ # Author: Ali Kahwaji
5
+
1
6
  name: Docs CI
2
7
 
3
8
  on:
@@ -7,31 +12,38 @@ on:
7
12
  branches: [main]
8
13
 
9
14
  jobs:
10
- build-docs:
15
+ build:
11
16
  runs-on: ubuntu-latest
12
17
  defaults:
13
18
  run:
14
19
  working-directory: docs-site
15
20
 
16
21
  steps:
17
- - name: ⬇️ Checkout repository
22
+ - name: Checkout repository
18
23
  uses: actions/checkout@v4
19
24
 
20
- - name: 🟢 Setup Node.js
25
+ - name: Setup Node.js
21
26
  uses: actions/setup-node@v4
22
27
  with:
23
28
  node-version: '18'
24
29
  cache: 'npm'
25
30
  cache-dependency-path: '**/package-lock.json'
26
31
 
27
- - name: 📦 Install dependencies
32
+ - name: Install dependencies
28
33
  run: npm ci
29
34
 
30
- - name: 🏗️ Build docs
35
+ - name: Lint codebase
36
+ run: npm run lint
37
+
38
+ - name: Validate docs build
31
39
  run: npm run docs:build
32
40
 
33
- - name: 🚀 Deploy to GitHub Pages (or similar)
34
- uses: peaceiris/actions-gh-pages@v4
41
+ - name: Run tests (optional)
42
+ run: npm test
43
+ if: ${{ always() }}
44
+
45
+ - name: Upload build artifacts (optional)
46
+ uses: actions/upload-artifact@v4
35
47
  with:
36
- github_token: ${{ secrets.GITHUB_TOKEN }}
37
- publish_dir: ./docs-site/build
48
+ name: docusaurus-build
49
+ path: docs-site/build
package/.github/workflows/docs-deploy.yml CHANGED
@@ -1,35 +1,50 @@
1
- name: Deploy Documentation to GitHub Pages
1
+ # .github/workflows/docs-deploy.yml
2
+ # Version: 1.0.0
3
+ # Description: Deploys Docusaurus docs site to GitHub Pages
4
+ # Author: Ali Kahwaji
5
+
6
+ name: 📚 Deploy Docusaurus Docs
2
7
 
3
8
  on:
4
9
  push:
5
10
  branches: [main]
6
- pull_request:
7
- branches: [main]
11
+ paths:
12
+ - 'docs-site/**'
13
+ - 'docs/**'
14
+ - 'blog/**'
15
+ - 'sidebars.js'
16
+ - 'docusaurus.config.js'
17
+ - 'package.json'
18
+
19
+ permissions:
20
+ contents: write # Required for GitHub Pages deployment
8
21
 
9
22
  jobs:
10
23
  deploy:
24
+ name: Deploy to GitHub Pages
11
25
  runs-on: ubuntu-latest
12
- defaults:
13
- run:
14
- working-directory: docs-site
15
26
 
16
27
  steps:
17
- - name: ⬇️ Checkout repository
28
+ - name: Checkout repository
18
29
  uses: actions/checkout@v4
19
30
 
20
- - name: 🟢 Setup Node.js
31
+ - name: Setup Node.js
21
32
  uses: actions/setup-node@v4
22
33
  with:
23
34
  node-version: '18'
35
+ cache: 'npm'
24
36
 
25
- - name: 📦 Install dependencies
37
+ - name: Install dependencies
26
38
  run: npm ci
27
39
 
28
- - name: 🏗️ Build docs
40
+ - name: Build docs
29
41
  run: npm run docs:build
30
42
 
31
- - name: 🚀 Deploy to GitHub Pages
43
+ - name: Deploy to GitHub Pages
32
44
  uses: peaceiris/actions-gh-pages@v4
33
45
  with:
34
46
  github_token: ${{ secrets.GITHUB_TOKEN }}
35
- publish_dir: ./docs-site/build
47
+ publish_dir: docs-site/build
48
+ publish_branch: gh-pages
49
+ user_name: github-actions[bot]
50
+ user_email: 41898282+github-actions[bot]@users.noreply.github.com
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.1.4](https://github.com/DevilsDev/rag-pipeline-utils/compare/v2.1.3...v2.1.4) (2025-04-21)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * update CI and deployment workflows for docs build and GitHub Pages deployment ([11739ba](https://github.com/DevilsDev/rag-pipeline-utils/commit/11739ba222669e359232807e461bc84d68d913cb))
9
+ * update CI and deployment workflows for docs build and GitHub Pages deployment ([8de276f](https://github.com/DevilsDev/rag-pipeline-utils/commit/8de276f8cb6c91a291322783dc944b0f4799974f))
10
+
3
11
  ## [2.1.3](https://github.com/DevilsDev/rag-pipeline-utils/compare/v2.1.2...v2.1.3) (2025-04-21)
4
12
 
5
13
 
package/docs-site/blog/2025-04-21-release-v2.1.3.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ slug: release-v2.1.3
3
+ title: ✨ Version v2.1.3 Released
4
+ authors: [ali]
5
+ tags: [release, changelog]
6
+ ---
7
+
8
+ RAG Pipeline Utils vv2.1.3 is now available on NPM!
9
+
10
+ #### Highlights
11
+ - 🚀 Auto-published blog from GitHub Release
12
+ - 📦 Version bump: v2.1.3
13
+ - 📘 See CHANGELOG.md for full details
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devilsdev/rag-pipeline-utils",
3
- "version": "2.1.3",
3
+ "version": "2.1.4",
4
4
  "description": "A modular toolkit for building RAG (Retrieval-Augmented Generation) pipelines in Node.js",
5
5
  "main": "src/core/create-pipeline.js",
6
6
  "bin": {