@devilsdev/rag-pipeline-utils 2.1.4 โ 2.1.5
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.
- package/.github/PROJECT_ROADMAP.md +102 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +8 -0
- package/.github/workflows/changelog-auto-commit.yml +37 -0
- package/.github/workflows/docs-ci.yml +9 -12
- package/.github/workflows/docs-deploy.yml +7 -2
- package/.github/workflows/enforce-release-review.yml +47 -0
- package/.github/workflows/release-sync.yml +50 -0
- package/.github/workflows/roadmap-label-sync.yml +35 -0
- package/.github/workflows/roadmap-labels.yml +67 -0
- package/.github/workflows/roadmap-sync.yml +44 -0
- package/.github/workflows/sync-roadmap.yml +62 -0
- package/CHANGELOG.md +7 -0
- package/README.md +33 -0
- package/__tests__/scripts/ensure-roadmap-labels.test.js +64 -0
- package/docs-site/blog/2025-04-21-release-v2.1.4.md +13 -0
- package/docs-site/package.json +4 -1
- package/package.json +7 -11
- package/scripts/banner-injector.js +82 -69
- package/scripts/close-done-roadmap-issues.js +65 -0
- package/scripts/create-roadmap-issues.js +47 -0
- package/scripts/ensure-roadmap-labels.js +73 -0
- package/scripts/label-roadmap-issues.js +125 -0
- package/scripts/manual-test-checklist.md +90 -0
- package/scripts/sync-labels.js +71 -0
- package/scripts/sync-roadmap-labels.js +21 -0
- package/scripts/tag-release.js +64 -0
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# ๐ฃ๏ธ Project Roadmap - RAG Pipeline Utils
|
|
2
|
+
|
|
3
|
+
> Version: 1.2.0
|
|
4
|
+
> Status: In Progress
|
|
5
|
+
> Last Updated: 2025-04-22
|
|
6
|
+
|
|
7
|
+
This roadmap guides the feature evolution, developer tooling, CI/CD automation, and community integration for the `@devilsdev/rag-pipeline-utils` project. Changes here are synchronized to GitHub Issues and CI workflows.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## โ
Legend
|
|
12
|
+
|
|
13
|
+
| Symbol | Meaning |
|
|
14
|
+
|--------|---------|
|
|
15
|
+
| โ
| Done |
|
|
16
|
+
| ๐ง | In Progress |
|
|
17
|
+
| ๐ | Upcoming |
|
|
18
|
+
| ๐งช | Experimental |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## ๐ฆ Phase 1: Foundation & CI/CD
|
|
23
|
+
|
|
24
|
+
| Feature | Status | Target Version | Tags |
|
|
25
|
+
|---------|--------|----------------|------|
|
|
26
|
+
| Automated test coverage with Jest | โ
Done | v2.0.0 | test, ci |
|
|
27
|
+
| Codecov integration + badge | โ
Done | v2.0.0 | ci, badge |
|
|
28
|
+
| GitHub Actions CI: lint, test, release | โ
Done | v2.0.0 | ci |
|
|
29
|
+
| GitHub Pages deploy for Docusaurus | โ
Done | v2.0.0 | docs, deploy |
|
|
30
|
+
| CHANGELOG auto-generation | โ
Done | v2.0.0 | release |
|
|
31
|
+
| Blog post sync from changelog | โ
Done | v2.1.0 | blog, release |
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## ๐ Phase 2: Community & Docs
|
|
36
|
+
|
|
37
|
+
| Feature | Status | Target Version | Tags |
|
|
38
|
+
|---------|--------|----------------|------|
|
|
39
|
+
| Interactive onboarding via CLI | ๐ง In Progress | v2.2.0 | devx, onboarding |
|
|
40
|
+
| GitHub Discussions integration | ๐ | v2.2.0 | community |
|
|
41
|
+
| Contributor guide & issue templates | โ
Done | v2.0.0 | community, docs |
|
|
42
|
+
| Roadmap โ GitHub Issues sync | โ
Done | v2.1.0 | ci, roadmap |
|
|
43
|
+
| Label sync from roadmap | โ
Done | v2.1.0 | ci, labels |
|
|
44
|
+
| Manual & automated blog generation | โ
Done | v2.1.1 | blog, release |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## ๐ง Phase 3: Developer Tooling
|
|
49
|
+
|
|
50
|
+
| Feature | Status | Target Version | Tags |
|
|
51
|
+
|---------|--------|----------------|------|
|
|
52
|
+
| CLI for `release:tag` with changelog preview | โ
Done | v2.1.1 | cli, release |
|
|
53
|
+
| Hydra.js integration for dynamic RAG config | ๐ง In Progress | v2.2.0 | config, hydra |
|
|
54
|
+
| CLI for roadmap issue tagging | โ
Done | v2.1.1 | cli, roadmap |
|
|
55
|
+
| Status badge: Release Review Passed | โ
Done | v2.1.1 | badge, ci |
|
|
56
|
+
| Kanban sync for roadmap issues | โ
Done | v2.1.1 | roadmap, ci |
|
|
57
|
+
| Custom VS Code snippets & workspace | ๐ | v2.3.0 | devx |
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## ๐ Phase 4: International & Advanced UX
|
|
62
|
+
|
|
63
|
+
| Feature | Status | Target Version | Tags |
|
|
64
|
+
|---------|--------|----------------|------|
|
|
65
|
+
| Blog subscribe + RSS | โ
Done | v2.1.1 | blog |
|
|
66
|
+
| i18n translation support | ๐ | v2.3.0 | i18n |
|
|
67
|
+
| SEO optimization + open graph cards | โ
Done | v2.1.1 | seo, meta |
|
|
68
|
+
| Comment system on blog posts | ๐ | v2.3.0 | blog, community |
|
|
69
|
+
| Performance tuning + SSR check | โ
Done | v2.1.0 | perf, ssr |
|
|
70
|
+
| Multilingual toggle in header | ๐ | v2.3.0 | i18n, ui |
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## ๐งฉ Future Enhancements
|
|
75
|
+
|
|
76
|
+
| Feature | Status | Target Version | Tags |
|
|
77
|
+
|---------|--------|----------------|------|
|
|
78
|
+
| Plugin support via CLI | ๐ | v2.4.0 | cli, plugin |
|
|
79
|
+
| Graph-based pipeline UI | ๐ | v2.5.0 | ux, devx |
|
|
80
|
+
| Real-world RAG examples + use cases | ๐ | v2.3.0 | docs, showcase |
|
|
81
|
+
| Prebuilt Docker image | ๐ | v2.4.0 | infra, deploy |
|
|
82
|
+
| Slack/Discord webhook for releases | ๐ | v2.3.0 | infra, notify |
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## ๐ Contributor Stats
|
|
87
|
+
|
|
88
|
+
- GitHub Insights Badge: 
|
|
89
|
+
- Roadmap Sync: `scripts/create-roadmap-issues.js`
|
|
90
|
+
- Label Sync: `scripts/ensure-roadmap-labels.js`
|
|
91
|
+
- CLI Integration: `scripts/release-changelog.js`, `scripts/sync-roadmap-cli.js`
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## ๐ Files
|
|
96
|
+
|
|
97
|
+
- `.github/PROJECT_ROADMAP.md` โ source
|
|
98
|
+
- `scripts/ensure-roadmap-labels.js` โ label sync
|
|
99
|
+
- `scripts/create-roadmap-issues.js` โ issue sync
|
|
100
|
+
- `scripts/close-roadmap-done.js` โ close done items
|
|
101
|
+
- `.github/workflows/sync-roadmap.yml` โ automation trigger
|
|
102
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
## โ
Release Quality Checklist
|
|
2
|
+
|
|
3
|
+
- [ ] CHANGELOG.md updated
|
|
4
|
+
- [ ] Blog post generated (`docs-site/blog/*release*.md`)
|
|
5
|
+
- [ ] `release:tag` and `release:sync` flows tested
|
|
6
|
+
|
|
7
|
+
<!-- CI Badge -->
|
|
8
|
+

|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Version: 1.0.0
|
|
2
|
+
# Description: Auto-commits CHANGELOG updates generated by tag-release CLI
|
|
3
|
+
# Author: Ali Kahwaji
|
|
4
|
+
|
|
5
|
+
name: ๐ Sync Changelog from CLI Tags
|
|
6
|
+
|
|
7
|
+
on:
|
|
8
|
+
push:
|
|
9
|
+
tags:
|
|
10
|
+
- 'v*'
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
commit-changelog:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
steps:
|
|
16
|
+
- name: โฌ๏ธ Checkout repo
|
|
17
|
+
uses: actions/checkout@v4
|
|
18
|
+
|
|
19
|
+
- name: ๐งฐ Setup Node.js
|
|
20
|
+
uses: actions/setup-node@v4
|
|
21
|
+
with:
|
|
22
|
+
node-version: 20
|
|
23
|
+
|
|
24
|
+
- name: ๐ฆ Install
|
|
25
|
+
run: npm ci
|
|
26
|
+
|
|
27
|
+
- name: ๐ Append Changelog Entry
|
|
28
|
+
run: |
|
|
29
|
+
VERSION=${GITHUB_REF#refs/tags/v}
|
|
30
|
+
node scripts/tag-release.js $VERSION
|
|
31
|
+
cat scripts/.cache/v$VERSION.log >> CHANGELOG.md
|
|
32
|
+
|
|
33
|
+
- name: ๐ Commit changelog
|
|
34
|
+
uses: stefanzweifel/git-auto-commit-action@v5
|
|
35
|
+
with:
|
|
36
|
+
commit_message: "docs(changelog): update for v${{ github.ref_name }}"
|
|
37
|
+
file_pattern: "CHANGELOG.md"
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# .github/workflows/docs-ci.yml
|
|
2
|
-
# Version: 1.
|
|
2
|
+
# Version: 1.1.0
|
|
3
3
|
# Description: CI pipeline for linting, testing, and building docs
|
|
4
4
|
# Author: Ali Kahwaji
|
|
5
5
|
|
|
@@ -14,35 +14,32 @@ on:
|
|
|
14
14
|
jobs:
|
|
15
15
|
build:
|
|
16
16
|
runs-on: ubuntu-latest
|
|
17
|
-
defaults:
|
|
18
|
-
run:
|
|
19
|
-
working-directory: docs-site
|
|
20
17
|
|
|
21
18
|
steps:
|
|
22
|
-
- name: Checkout repository
|
|
19
|
+
- name: โฌ๏ธ Checkout repository
|
|
23
20
|
uses: actions/checkout@v4
|
|
24
21
|
|
|
25
|
-
- name: Setup Node.js
|
|
22
|
+
- name: ๐ข Setup Node.js
|
|
26
23
|
uses: actions/setup-node@v4
|
|
27
24
|
with:
|
|
28
25
|
node-version: '18'
|
|
29
26
|
cache: 'npm'
|
|
30
|
-
cache-dependency-path: '
|
|
27
|
+
cache-dependency-path: 'package-lock.json'
|
|
31
28
|
|
|
32
|
-
- name: Install dependencies
|
|
29
|
+
- name: ๐ฆ Install dependencies
|
|
33
30
|
run: npm ci
|
|
34
31
|
|
|
35
|
-
- name: Lint codebase
|
|
32
|
+
- name: ๐งน Lint codebase
|
|
36
33
|
run: npm run lint
|
|
37
34
|
|
|
38
|
-
- name:
|
|
35
|
+
- name: ๐ Build documentation
|
|
39
36
|
run: npm run docs:build
|
|
40
37
|
|
|
41
|
-
- name: Run tests (optional)
|
|
38
|
+
- name: โ
Run tests (optional)
|
|
42
39
|
run: npm test
|
|
43
40
|
if: ${{ always() }}
|
|
44
41
|
|
|
45
|
-
- name: Upload build
|
|
42
|
+
- name: ๐ฆ Upload docs build (optional)
|
|
46
43
|
uses: actions/upload-artifact@v4
|
|
47
44
|
with:
|
|
48
45
|
name: docusaurus-build
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# .github/workflows/docs-deploy.yml
|
|
2
|
-
# Version: 1.
|
|
2
|
+
# Version: 1.1.0
|
|
3
3
|
# Description: Deploys Docusaurus docs site to GitHub Pages
|
|
4
4
|
# Author: Ali Kahwaji
|
|
5
5
|
|
|
@@ -40,6 +40,11 @@ jobs:
|
|
|
40
40
|
- name: Build docs
|
|
41
41
|
run: npm run docs:build
|
|
42
42
|
|
|
43
|
+
- name: Configure Git user
|
|
44
|
+
run: |
|
|
45
|
+
git config --global user.name "GitHub Actions"
|
|
46
|
+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
|
|
47
|
+
|
|
43
48
|
- name: Deploy to GitHub Pages
|
|
44
49
|
uses: peaceiris/actions-gh-pages@v4
|
|
45
50
|
with:
|
|
@@ -47,4 +52,4 @@ jobs:
|
|
|
47
52
|
publish_dir: docs-site/build
|
|
48
53
|
publish_branch: gh-pages
|
|
49
54
|
user_name: github-actions[bot]
|
|
50
|
-
user_email:
|
|
55
|
+
user_email: github-actions[bot]@users.noreply.github.com
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# .github/workflows/enforce-release-review.yml
|
|
2
|
+
# Version: 1.0.1
|
|
3
|
+
# Description: Prevents merge if changelog/blog updates not reviewed. Supports badge + manual trigger.
|
|
4
|
+
# Author: Ali Kahwaji
|
|
5
|
+
|
|
6
|
+
name: ๐ก Release Review Enforcement
|
|
7
|
+
|
|
8
|
+
on:
|
|
9
|
+
pull_request:
|
|
10
|
+
branches: [main]
|
|
11
|
+
workflow_dispatch: # โ
Manual trigger from Actions tab
|
|
12
|
+
|
|
13
|
+
permissions:
|
|
14
|
+
contents: read
|
|
15
|
+
pull-requests: write
|
|
16
|
+
|
|
17
|
+
jobs:
|
|
18
|
+
review-check:
|
|
19
|
+
name: Validate Changelog & Blog Updates
|
|
20
|
+
runs-on: ubuntu-latest
|
|
21
|
+
|
|
22
|
+
steps:
|
|
23
|
+
- name: ๐ฅ Checkout repo
|
|
24
|
+
uses: actions/checkout@v4
|
|
25
|
+
|
|
26
|
+
- name: ๐ Scan for changelog/blog edits
|
|
27
|
+
id: check
|
|
28
|
+
run: |
|
|
29
|
+
git fetch origin main --depth=1
|
|
30
|
+
CHANGED_FILES=$(git diff --name-only origin/main...HEAD)
|
|
31
|
+
|
|
32
|
+
echo "Changed files:"
|
|
33
|
+
echo "$CHANGED_FILES"
|
|
34
|
+
|
|
35
|
+
if echo "$CHANGED_FILES" | grep -qE 'CHANGELOG\.md|docs-site/blog/'; then
|
|
36
|
+
echo "โ
Changelog or blog post updated."
|
|
37
|
+
echo "result=pass" >> "$GITHUB_OUTPUT"
|
|
38
|
+
else
|
|
39
|
+
echo "โ No changelog or blog edits found."
|
|
40
|
+
echo "result=fail" >> "$GITHUB_OUTPUT"
|
|
41
|
+
fi
|
|
42
|
+
|
|
43
|
+
- name: ๐ซ Fail if missing changelog or blog updates
|
|
44
|
+
if: steps.check.outputs.result == 'fail'
|
|
45
|
+
run: |
|
|
46
|
+
echo "Missing required changelog or blog post for release."
|
|
47
|
+
exit 1
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# .github/workflows/release-sync.yml
|
|
2
|
+
# Version: 1.0.0
|
|
3
|
+
# Description: Syncs changelog/tag to blog post
|
|
4
|
+
# Author: Ali Kahwaji
|
|
5
|
+
|
|
6
|
+
name: ๐ Release Sync
|
|
7
|
+
|
|
8
|
+
on:
|
|
9
|
+
push:
|
|
10
|
+
tags:
|
|
11
|
+
- 'v*' # any pushed Git tag
|
|
12
|
+
paths:
|
|
13
|
+
- 'CHANGELOG.md'
|
|
14
|
+
- 'scripts/**'
|
|
15
|
+
- '.github/workflows/release-sync.yml'
|
|
16
|
+
|
|
17
|
+
permissions:
|
|
18
|
+
contents: write
|
|
19
|
+
id-token: write
|
|
20
|
+
|
|
21
|
+
jobs:
|
|
22
|
+
publish-release-blog:
|
|
23
|
+
name: ๐ Create Blog Post from CHANGELOG + Tag
|
|
24
|
+
runs-on: ubuntu-latest
|
|
25
|
+
|
|
26
|
+
steps:
|
|
27
|
+
- name: ๐งพ Checkout Repo
|
|
28
|
+
uses: actions/checkout@v4
|
|
29
|
+
with:
|
|
30
|
+
fetch-depth: 0 # get full commit history for changelog diff
|
|
31
|
+
|
|
32
|
+
- name: ๐งฐ Setup Node
|
|
33
|
+
uses: actions/setup-node@v4
|
|
34
|
+
with:
|
|
35
|
+
node-version: 20
|
|
36
|
+
|
|
37
|
+
- name: ๐ฆ Install deps
|
|
38
|
+
run: npm ci
|
|
39
|
+
|
|
40
|
+
- name: ๐ Generate blog post
|
|
41
|
+
run: |
|
|
42
|
+
VERSION=${GITHUB_REF#refs/tags/}
|
|
43
|
+
PREV=$(git tag --sort=committerdate | grep -B1 $VERSION | head -n1)
|
|
44
|
+
node scripts/generate-release-note.js $VERSION $PREV
|
|
45
|
+
|
|
46
|
+
- name: ๐ฌ Commit release blog
|
|
47
|
+
uses: stefanzweifel/git-auto-commit-action@v5
|
|
48
|
+
with:
|
|
49
|
+
commit_message: "docs(blog): auto-publish release notes for ${{ github.ref_name }}"
|
|
50
|
+
file_pattern: "docs-site/blog/*.md"
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
name: ๐ Sync Roadmap Labels
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
paths:
|
|
6
|
+
- '.github/roadmap-labels.yml'
|
|
7
|
+
- 'scripts/sync-roadmap-labels.js'
|
|
8
|
+
workflow_dispatch:
|
|
9
|
+
|
|
10
|
+
permissions:
|
|
11
|
+
issues: write
|
|
12
|
+
contents: read
|
|
13
|
+
|
|
14
|
+
jobs:
|
|
15
|
+
sync-labels:
|
|
16
|
+
runs-on: ubuntu-latest
|
|
17
|
+
name: Sync Labels from Roadmap Config
|
|
18
|
+
|
|
19
|
+
steps:
|
|
20
|
+
- name: ๐ฅ Checkout repo
|
|
21
|
+
uses: actions/checkout@v4
|
|
22
|
+
|
|
23
|
+
- name: ๐ Setup Node.js
|
|
24
|
+
uses: actions/setup-node@v4
|
|
25
|
+
with:
|
|
26
|
+
node-version: 20
|
|
27
|
+
cache: 'npm'
|
|
28
|
+
|
|
29
|
+
- name: ๐ฆ Install dependencies
|
|
30
|
+
run: npm ci
|
|
31
|
+
|
|
32
|
+
- name: ๐ Run label sync script
|
|
33
|
+
run: node scripts/sync-roadmap-labels.js
|
|
34
|
+
env:
|
|
35
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Version: 1.0.0
|
|
2
|
+
# Description: Ensures roadmap labels (priority, group) exist in the repo
|
|
3
|
+
# Author: Ali Kahwaji
|
|
4
|
+
|
|
5
|
+
name: ๐ Sync Roadmap Labels
|
|
6
|
+
|
|
7
|
+
on:
|
|
8
|
+
workflow_dispatch:
|
|
9
|
+
push:
|
|
10
|
+
paths:
|
|
11
|
+
- '.github/workflows/roadmap-labels.yml'
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
sync-labels:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
|
|
17
|
+
steps:
|
|
18
|
+
- name: โฌ๏ธ Checkout repository
|
|
19
|
+
uses: actions/checkout@v4
|
|
20
|
+
|
|
21
|
+
- name: ๐ข Setup Node.js
|
|
22
|
+
uses: actions/setup-node@v4
|
|
23
|
+
with:
|
|
24
|
+
node-version: 20
|
|
25
|
+
|
|
26
|
+
- name: ๐ฆ Install octokit
|
|
27
|
+
run: npm install octokit
|
|
28
|
+
|
|
29
|
+
- name: ๐ Run label sync
|
|
30
|
+
env:
|
|
31
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
32
|
+
GITHUB_REPO: ${{ github.repository }}
|
|
33
|
+
run: |
|
|
34
|
+
node <<EOF
|
|
35
|
+
const { Octokit } = require("octokit");
|
|
36
|
+
|
|
37
|
+
const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });
|
|
38
|
+
const [owner, repo] = process.env.GITHUB_REPO.split("/");
|
|
39
|
+
|
|
40
|
+
const labels = [
|
|
41
|
+
{ name: "priority: high", color: "e11d48", description: "High priority roadmap item" },
|
|
42
|
+
{ name: "priority: medium", color: "f59e0b", description: "Medium priority roadmap item" },
|
|
43
|
+
{ name: "priority: low", color: "10b981", description: "Low priority roadmap item" },
|
|
44
|
+
{ name: "group: docs", color: "6366f1", description: "Documentation features" },
|
|
45
|
+
{ name: "group: devx", color: "06b6d4", description: "Developer experience improvements" },
|
|
46
|
+
{ name: "group: community", color: "ec4899", description: "Community tools & engagement" },
|
|
47
|
+
{ name: "group: blog", color: "f97316", description: "Blog & SEO enhancements" },
|
|
48
|
+
{ name: "group: infra", color: "64748b", description: "Infrastructure & deployment features" }
|
|
49
|
+
];
|
|
50
|
+
|
|
51
|
+
(async () => {
|
|
52
|
+
const existing = await octokit.rest.issues.listLabelsForRepo({ owner, repo });
|
|
53
|
+
const existingNames = new Set(existing.data.map(l => l.name));
|
|
54
|
+
|
|
55
|
+
for (const label of labels) {
|
|
56
|
+
if (!existingNames.has(label.name)) {
|
|
57
|
+
console.log(`โ Creating label: ${label.name}`);
|
|
58
|
+
await octokit.rest.issues.createLabel({ owner, repo, ...label });
|
|
59
|
+
} else {
|
|
60
|
+
console.log(`โ
Label already exists: ${label.name}`);
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
})().catch(err => {
|
|
64
|
+
console.error("Label sync failed:", err);
|
|
65
|
+
process.exit(1);
|
|
66
|
+
});
|
|
67
|
+
EOF
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
name: ๐ Roadmap Sync (Labels + Issues)
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
paths:
|
|
7
|
+
- '.github/roadmap-labels.yml'
|
|
8
|
+
- '.github/PROJECT_ROADMAP.md'
|
|
9
|
+
- 'scripts/create-roadmap-issues.js'
|
|
10
|
+
- 'scripts/ensure-roadmap-labels.js'
|
|
11
|
+
|
|
12
|
+
workflow_dispatch:
|
|
13
|
+
|
|
14
|
+
permissions:
|
|
15
|
+
issues: write
|
|
16
|
+
contents: read
|
|
17
|
+
|
|
18
|
+
jobs:
|
|
19
|
+
roadmap-sync:
|
|
20
|
+
name: ๐ Sync Labels + Issues from Roadmap
|
|
21
|
+
runs-on: ubuntu-latest
|
|
22
|
+
|
|
23
|
+
steps:
|
|
24
|
+
- name: ๐ฅ Checkout repository
|
|
25
|
+
uses: actions/checkout@v4
|
|
26
|
+
|
|
27
|
+
- name: ๐ Setup Node.js
|
|
28
|
+
uses: actions/setup-node@v4
|
|
29
|
+
with:
|
|
30
|
+
node-version: 20
|
|
31
|
+
cache: 'npm'
|
|
32
|
+
|
|
33
|
+
- name: ๐ฆ Install dependencies
|
|
34
|
+
run: npm ci
|
|
35
|
+
|
|
36
|
+
- name: ๐ Sync GitHub labels from roadmap-labels.yml
|
|
37
|
+
run: node scripts/ensure-roadmap-labels.js
|
|
38
|
+
env:
|
|
39
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
40
|
+
|
|
41
|
+
- name: ๐ Create or update roadmap issues
|
|
42
|
+
run: node scripts/create-roadmap-issues.js
|
|
43
|
+
env:
|
|
44
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# .github/workflows/sync-roadmap.yml
|
|
2
|
+
# Version: 2.1.0
|
|
3
|
+
# Description: Unified workflow to sync roadmap issues, labels, and states
|
|
4
|
+
# Author: Ali Kahwaji
|
|
5
|
+
|
|
6
|
+
name: ๐ Sync Roadmap to GitHub Issues
|
|
7
|
+
|
|
8
|
+
on:
|
|
9
|
+
workflow_dispatch:
|
|
10
|
+
push:
|
|
11
|
+
branches: [main]
|
|
12
|
+
paths:
|
|
13
|
+
- '.github/PROJECT_ROADMAP.md'
|
|
14
|
+
- '.github/workflows/sync-roadmap.yml'
|
|
15
|
+
- 'scripts/**.js'
|
|
16
|
+
|
|
17
|
+
permissions:
|
|
18
|
+
contents: write
|
|
19
|
+
issues: write
|
|
20
|
+
|
|
21
|
+
jobs:
|
|
22
|
+
sync:
|
|
23
|
+
name: ๐ Roadmap Sync
|
|
24
|
+
runs-on: ubuntu-latest
|
|
25
|
+
|
|
26
|
+
steps:
|
|
27
|
+
- name: โฌ๏ธ Checkout
|
|
28
|
+
uses: actions/checkout@v4
|
|
29
|
+
|
|
30
|
+
- name: ๐ Setup Node.js
|
|
31
|
+
uses: actions/setup-node@v4
|
|
32
|
+
with:
|
|
33
|
+
node-version: 20
|
|
34
|
+
|
|
35
|
+
- name: ๐ฆ Install roadmap dependencies
|
|
36
|
+
run: npm install
|
|
37
|
+
env:
|
|
38
|
+
NODE_ENV: development
|
|
39
|
+
|
|
40
|
+
- name: ๐ Ensure roadmap labels exist
|
|
41
|
+
run: node scripts/ensure-roadmap-labels.js
|
|
42
|
+
env:
|
|
43
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
44
|
+
GITHUB_REPO: ${{ github.repository }}
|
|
45
|
+
|
|
46
|
+
- name: ๐ Sync roadmap issues
|
|
47
|
+
run: node scripts/create-roadmap-issues.js
|
|
48
|
+
env:
|
|
49
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
50
|
+
GITHUB_REPO: ${{ github.repository }}
|
|
51
|
+
|
|
52
|
+
- name: ๐ท Apply labels to roadmap issues
|
|
53
|
+
run: node scripts/label-roadmap-issues.js
|
|
54
|
+
env:
|
|
55
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
56
|
+
GITHUB_REPO: ${{ github.repository }}
|
|
57
|
+
|
|
58
|
+
- name: โ
Close completed issues
|
|
59
|
+
run: node scripts/close-done-roadmap-issues.js
|
|
60
|
+
env:
|
|
61
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
62
|
+
GITHUB_REPO: ${{ github.repository }}
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [2.1.5](https://github.com/DevilsDev/rag-pipeline-utils/compare/v2.1.4...v2.1.5) (2025-04-22)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* **scripts:** prevent null status crash in roadmap issue closer ([89d5a0b](https://github.com/DevilsDev/rag-pipeline-utils/commit/89d5a0bc4cac554975974558b97974297816f169))
|
|
9
|
+
|
|
3
10
|
## [2.1.4](https://github.com/DevilsDev/rag-pipeline-utils/compare/v2.1.3...v2.1.4) (2025-04-21)
|
|
4
11
|
|
|
5
12
|
|
package/README.md
CHANGED
|
@@ -10,6 +10,9 @@
|
|
|
10
10
|
[](https://codecov.io/gh/DevilsDev/rag-pipeline-utils)
|
|
11
11
|

|
|
12
12
|

|
|
13
|
+

|
|
14
|
+
|
|
15
|
+
|
|
13
16
|
|
|
14
17
|
## Description
|
|
15
18
|
|
|
@@ -136,6 +139,36 @@ We welcome contributions via PRs, especially new mock providers, validation help
|
|
|
136
139
|
|
|
137
140
|
|
|
138
141
|
|
|
142
|
+
## Contributors Guide
|
|
143
|
+
|
|
144
|
+
For active maintainers and collaborators:
|
|
145
|
+
|
|
146
|
+
- **Roadmap & Feature Planning**
|
|
147
|
+
See [.github/PROJECT_ROADMAP.md](.github/PROJECT_ROADMAP.md) for the implementation phases, priorities, and tracking tags for all major developer-facing features.
|
|
148
|
+
|
|
149
|
+
- **Milestone Tags**
|
|
150
|
+
| Tag | Description |
|
|
151
|
+
|-------------|------------------------------------|
|
|
152
|
+
| `phase-1` | Foundation โ testing, CI, tutorials |
|
|
153
|
+
| `phase-2` | Community, blog, discussions |
|
|
154
|
+
| `phase-3` | CLI, VS Code tools, theming |
|
|
155
|
+
| `phase-4` | i18n, integrations, case studies |
|
|
156
|
+
|
|
157
|
+
_Note: This file is not included in public documentation builds._
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
## Manual Test Checklist
|
|
161
|
+
|
|
162
|
+
For full validation of roadmap sync, changelog automation, CI/CD, and blog generation:
|
|
163
|
+
|
|
164
|
+
โก๏ธ [View Manual Test Checklist](scripts/manual-test-checklist.md)
|
|
165
|
+
|
|
166
|
+
## Manual CI Rollout
|
|
167
|
+
|
|
168
|
+
git commit --allow-empty -m "ci(test): trigger all CI workflows"
|
|
169
|
+
git push origin main
|
|
170
|
+
|
|
171
|
+
|
|
139
172
|
## License
|
|
140
173
|
|
|
141
174
|
This project is licensed under the **GNU GPL v3.0** License - see the [LICENSE](./LICENSE) file for details.
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Version: 2.1.2
|
|
3
|
+
* Path: __tests__/scripts/ensure-roadmap-labels.test.js
|
|
4
|
+
* Description: Unit tests for roadmap label creation using ESM-compatible Jest syntax.
|
|
5
|
+
* Author: Ali Kahwaji
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { jest } from '@jest/globals';
|
|
9
|
+
|
|
10
|
+
jest.unstable_mockModule('octokit', () => ({
|
|
11
|
+
Octokit: jest.fn().mockImplementation(() => ({
|
|
12
|
+
rest: {
|
|
13
|
+
issues: {
|
|
14
|
+
listLabelsForRepo: mockListLabelsForRepo,
|
|
15
|
+
createLabel: mockCreateLabel
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
}))
|
|
19
|
+
}));
|
|
20
|
+
|
|
21
|
+
// โ
Shared mocks outside import context
|
|
22
|
+
const mockCreateLabel = jest.fn();
|
|
23
|
+
const mockListLabelsForRepo = jest.fn();
|
|
24
|
+
|
|
25
|
+
let ensureRoadmapLabels;
|
|
26
|
+
let roadmapLabels;
|
|
27
|
+
|
|
28
|
+
beforeAll(async () => {
|
|
29
|
+
const imported = await import('../../scripts/ensure-roadmap-labels.js');
|
|
30
|
+
ensureRoadmapLabels = imported.ensureRoadmapLabels;
|
|
31
|
+
roadmapLabels = imported.roadmapLabels;
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
beforeEach(() => {
|
|
35
|
+
mockCreateLabel.mockReset();
|
|
36
|
+
mockListLabelsForRepo.mockReset();
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
describe('ensureRoadmapLabels', () => {
|
|
40
|
+
it('creates all labels if none exist', async () => {
|
|
41
|
+
mockListLabelsForRepo.mockResolvedValue({ data: [] });
|
|
42
|
+
|
|
43
|
+
await ensureRoadmapLabels({ token: 'test-token', owner: 'ali', repo: 'rag-pipeline-utils' });
|
|
44
|
+
|
|
45
|
+
expect(mockCreateLabel).toHaveBeenCalledTimes(roadmapLabels.length);
|
|
46
|
+
for (const label of roadmapLabels) {
|
|
47
|
+
expect(mockCreateLabel).toHaveBeenCalledWith({
|
|
48
|
+
owner: 'ali',
|
|
49
|
+
repo: 'rag-pipeline-utils',
|
|
50
|
+
...label
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
it('skips already existing labels', async () => {
|
|
56
|
+
const existing = [{ name: 'priority: high' }, { name: 'group: docs' }];
|
|
57
|
+
mockListLabelsForRepo.mockResolvedValue({ data: existing });
|
|
58
|
+
|
|
59
|
+
await ensureRoadmapLabels({ token: 'test-token', owner: 'ali', repo: 'rag-pipeline-utils' });
|
|
60
|
+
|
|
61
|
+
const expected = roadmapLabels.filter(l => !existing.some(e => e.name === l.name));
|
|
62
|
+
expect(mockCreateLabel).toHaveBeenCalledTimes(expected.length);
|
|
63
|
+
});
|
|
64
|
+
});
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
slug: release-v2.1.4
|
|
3
|
+
title: โจ Version v2.1.4 Released
|
|
4
|
+
authors: [ali]
|
|
5
|
+
tags: [release, changelog]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
RAG Pipeline Utils vv2.1.4 is now available on NPM!
|
|
9
|
+
|
|
10
|
+
#### Highlights
|
|
11
|
+
- ๐ Auto-published blog from GitHub Release
|
|
12
|
+
- ๐ฆ Version bump: v2.1.4
|
|
13
|
+
- ๐ See CHANGELOG.md for full details
|
package/docs-site/package.json
CHANGED
|
@@ -11,7 +11,10 @@
|
|
|
11
11
|
"clear": "docusaurus clear",
|
|
12
12
|
"serve": "docusaurus serve",
|
|
13
13
|
"write-translations": "docusaurus write-translations",
|
|
14
|
-
"write-heading-ids": "docusaurus write-heading-ids"
|
|
14
|
+
"write-heading-ids": "docusaurus write-heading-ids",
|
|
15
|
+
"lint": "echo 'Lint skipped for docs-site'",
|
|
16
|
+
"test": "echo 'No tests in docs-site. Run from root.'",
|
|
17
|
+
"docs:build": "npm run --workspace ../ docs:build"
|
|
15
18
|
},
|
|
16
19
|
"dependencies": {
|
|
17
20
|
"@docusaurus/core": "3.7.0",
|