Chuyển tới nội dung chính

Xuất bản (Publishing)

AIDK được xuất bản lên GitHub Packages dưới dạng package riêng tư (@aquaringlab/aidk). Dưới đây là toàn bộ quy trình.

Yêu cầu trước khi xuất bản​

  1. Bạn phải có quyền write:packages trên tổ chức GitHub aquaringlab.
  2. Đã có Personal Access Token (PAT) GitHub với scope write:packages.
  3. File .npmrc được cấu hình đúng.

Bước 1: Tạo GitHub PAT​

Truy cập github.com/settings/tokens → Generate new token (Classic).

Chọn các scope:

  • write:packages
  • read:packages
  • repo

Bước 2: Cấu hình .npmrc​

Thêm vào file ~/.npmrc trên máy cục bộ:

@aquaringlab:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_PAT
cẩn thận

Không commit token thực vào file .npmrc. Dùng biến môi trường hoặc ~/.npmrc.

Bước 3: Build trước khi xuất bản​

npm run build

Kiểm tra kết quả build trong thư mục dist/.

Bước 4: Cập nhật version​

Dùng npm version để cập nhật package.json theo Semantic Versioning:

# Patch (0.2.0 -> 0.2.1)
npm version patch

# Minor (0.2.0 -> 0.3.0)
npm version minor

# Major (0.2.0 -> 1.0.0)
npm version major

Bước 5: Xuất bản​

npm publish

Lệnh prepublishOnly trong package.json sẽ tự động chạy npm run build trước khi publish.

Xuất bản qua GitHub Actions (Tự động)​

Quy trình thủ công trên đây chỉ dành cho trường hợp khẩn cấp. Thông thường, việc xuất bản được thực hiện tự động qua GitHub Actions khi push tag v* lên repository aquaringlab/lab-tool-ai-kit.

git tag -a v0.16.0 -m "chore: release v0.16.0"
git push aql main --follow-tags

Kiểm tra sau khi xuất bản​

Sau khi publish, kiểm tra package đã có mặt tại:

  • GitHub Packages: https://github.com/aquaringlab/lab-tool-ai-kit/packages
  • Hoặc thử cài đặt: npm install -g @aquaringlab/aidk@<version>

Cập nhật CHANGELOG​

Luôn cập nhật file CHANGELOG.md trước khi xuất bản để ghi lại các thay đổi trong version mới.