CI/CD cho ứng dụng Node.js với Github Action

Bài đăng này đã không được cập nhật trong 4 năm

Bài viết này sẽ đề cập đến những điều sau:

Sử dụng Docker để khởi động 1 app
Sử dụng các GitHub Action để tích hợp liên tục (CI) ứng dụng của bạn
Sử dụng các GitHub Action để triển khai liên tục (CD) bằng cách đẩy image Docker vào Docker registry (Docker Hub)

Flow sẽ đại loại như này

Code đầy đủ sẽ có ở trong này

Sử dụng Docker để khởi động 1 app

Thiết lập docker cho 1 ứng dụng khá đơn giản. Điều bạn cần là 1 file Dockerfile và thêm option .dockerignore

Đây là 1 ví dụ

Nó sẽ copy package.json, chạy npm install và start server. Để đảm bảo tệp là chính xác, bạn có thể chạy docker build -t abhinavdhasmana/github-action-example-node . từ thư root. Nếu bạn chạy docker images, bạn sẽ thấy image bản lastest. Bạn cũng có thể chạy container bằng lệnh docker run -d -p 3000:3000 abhinavdhasmana/github-action-example-node. Truy cập trình duyệt đến http://localhost:3000/ và có 1 đoạn text sẽ xuất hiện.

Github Action là gì, và nó hoạt động như thế nào

‘GitHub Actions’ là một API có thể phản ứng với bất kỳ sự kiện nào, sự kiện của GitHub hoặc của chính chúng ta. Ví dụ: khi có sự kiện push lên repository, thì chúng ta muốn unit test được chạy

Để Github Action hoạt động, chúng ta cần tạo 1 folder .github/workflows và chúng ta sẽ tạo các workflow trong này. Hãy tạo file push.yml

Đây là những gì chúng ta sẽ thực hiện trong flow

git clone the repo
run npm install
run npm lint
run npm test
build the docker image 6 login to docker hub
Push the image to docker hub

File push.yml sẽ trông như thế này

Giải thích qua 1 chút về file

dòng 1: Sự kiện mà chúng mà muốn trigger, push

dòng 3–6: Chúng ta đang xác định một job build-and-publish chạy trên ubuntu mới nhất. Mỗi job chạy trong một phiên khác nhau của môi trường ảo. Một job có thể chứa một hoặc nhiều bước.

dòng 8: Đây là bước 1 trong ứng dụng của chúng ta. Ở đây chúng ta sẽ lấy source code. Bạn cũng có thể viết ra 1 đoạn script của riêng mình để pull code hoặc sử dụng lại một mã nguồn mở. https://github.com/actions/checkout

dòng 9-12: Đây là bước 2 trong workerflow của chúng ta, nơi chúng ta chạy npm install trên source code. Một lần nữa, chúng ta sử dụng một action nguồn mở tại https://github.com/actions/npm và chuyển đối số.

dòng 13–20: Đây là bước chạy test, kiểm tra convention.

dòng 21–24: Chúng ta tạo docker image cho source code với sự trợ giúp của docker cli và gắn tag cho image là abhinavdhasmana/github-action-example-node

dòng 25-29: Dòng này là đăng nhập vào Docker hub. Ở đây chúng ta sử dụng các secrest key được chuyển dưới dạng biến env cho bản biuld. Chúng ta có thể đặt các biến env này theo nhiều cách. Để thiết lập điều này qua GitHub, hãy đi tới Settings-> Secrets và tạo key mới

dòng 30-33: Chúng ta đẩy image vào docker hub với thẻ mà chúng ta đã tạo ở dòng 24.

Nếu chúng ta push code, và comit thay đổi, GitHub Actions sẽ hoạt động và bắt đầu chạy tất cả các bước trong workflow của chúng ta. Chúng ta sẽ thấy một cái gì đó như thế này