Hướng dẫn thiết lập token github để cài đặt các private package azoom

github-token-setup.md

THIẾT LẬP GITHUB TOKEN

Trong quá trình làm việc các dự án trong Azoom, có thể sử dụng các private package @azoom ( các package private được lưu trữ trên Github packages). Để cài đặt,tạo mới hoặc update các package loại này, cần thiết lập github token.

Cài đặt cá nhân

Trước tiên chúng ta cần tạo Github token , sau đó sử dụng chúng để xác thực với Github.

1. Tạo token
   Yêu cầu token được tạo cần có các quyền sau

   • repo (to access private repo - IMPORTANT)
   • write:packages (to update packages)
   • read:packages (to read/install packages)
   • delete:packages (to delete packages)

   Các bước tạo token

   • Đăng nhập Github, sau đó tìm đến Personal access tokens setting page
   • Click Generate new token , sau đó lựa chọn các quyền trên
   • Click Generate token ( lưu ý token được tạo chỉ hiển thị 1 lần ngay sau khi nhấn Generate token, yêu cầu lưu lại token trên)

2. Xác thực với Github
   Sau khi đã có token ở bước 1, tiếp theo sẽ tiến hành xác thực. Có 2 cách để xác thực

   1. Sử dung npm login --registry=https://npm.pkg.github.com --scope=@azoom Lưu ý Github yêu cầu đăng nhập cùng các thông tin sau

      • username : GITHUB USERNAME
      • password : TOKEN VỪA TẠO
      • email : GITHUB PUBLIC EMAIL

   2. Xác thực thủ công

      • Mở file ~/.npmrc (hoặc tạo mới tại THƯ MỤC GỐC CỦA USER HIỆN TẠI nếu chưa có)
      • Thêm nội dung dưới vào file trên.

      //npm.pkg.github.com/:_authToken=[CREATED-TOKEN]
      @azoom:registry=https://npm.pkg.github.com/
      

   Lưu ý:

   • Đây là các bước để tạo xác thực với github nhằm mục đích có thể install các private package khi dùng npm install hoặc yarrn install
   • Các thiết lập trên áp dụng cho việc cài đặt các package của azoom mọi nơi trên MÁY TÍNH của bạn. Để cài đặt cho CI/Build proccess, vui lòng sử dụng hướng dẫn cài đặt cho dự án dưới đây

Cài đặt cho dự án

Cài đặt cho dự án (trong CI/Build tool) Trong quá trình build project, nếu không có các bước đăng nhâp và xác thực Github như trên, quá trình build project sẽ fail

Trong các project có sử dụng các thư việc private của @azoom, cần thêm 1 file .npmrc tại thư mục gốc dự án, nhằm mục đích hướng dẫn npm/yarn cài đặt đúng package. Thao tác sẽ như sau

• Thêm config sau vào file .npmrc ( file nằm trong thư mục root)

@azoom:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=[PREDEFINED-TOKEN-HERE]

• Thay đổi PREDEFINED-TOKEN-HERE bằng token nằm trong folder deployment/staging hoặc production ( trường hợp không có vui lòng liên hệ với team lead).

Thông tin chi tiết vui lòng tham khảo

• Configuring npm for use with GitHub Packages