Các hành động của GitHub là một nền tảng DevOps cho phép bạn tích hợp các thực hành tích hợp liên tục [CI] và phân phối liên tục [CD] với kho lưu trữ mã của bạn trong GitHub. Trong bài đăng trên blog này, tôi sẽ giải thích CI là gì và tại sao bạn nên sử dụng nó cũng như cách triển khai nó trong GitHub Actions với một dự án Python ví dụ đi kèm
Tích hợp liên tục là gì?
Tích hợp liên tục là một quy trình DevOps và về cơ bản có nghĩa là tự động hóa quy trình tích hợp các thay đổi mã vào kho lưu trữ mã. Ý tưởng chung là như sau. bạn thực hiện các thay đổi đối với kho lưu trữ mã từ xa [e. g. GitHub], kích hoạt quá trình xây dựng và thử nghiệm tự động – mã đã cam kết được xây dựng trên một máy chủ từ xa và các thử nghiệm được chạy đối với nó. Đó là cốt lõi của CI
Khía cạnh tự động hóa của CI làm giảm kịch tính và ma sát liên quan đến việc đưa ra các thay đổi đối với cơ sở mã. Lợi ích chính của việc này là bạn nhận được phản hồi nhanh chóng về việc liệu thay đổi của bạn có xung đột với những thay đổi do người khác thực hiện hay không. Điều này khuyến khích phát triển lô nhỏ – thay đổi càng nhỏ thì càng ít có khả năng xảy ra xung đột hợp nhất và khi có xung đột thì sẽ dễ giải quyết hơn vì chỉ một lượng nhỏ mã đã thay đổi
Phát triển lô nhỏ là một khía cạnh chính của các nguyên tắc DevOps vì những lý do khác ngoài lý do này. thắt chặt các vòng phản hồi, tăng năng suất của nhà phát triển, tăng chất lượng mã, giảm rủi ro khi triển khai mã. Đó là chìa khóa cho ý tưởng mang lại giá trị liên tục thông qua những thay đổi nhỏ, gia tăng và thường xuyên
Ngoài việc chỉ ra xung đột hợp nhất và có lẽ quan trọng hơn, CI cung cấp phản hồi nhanh về chất lượng và tính chính xác của mã thông qua các bước xây dựng và kiểm tra. Vì lý do này, CI cũng bổ sung cho sự phát triển lô nhỏ. Thông thường, mã không vượt qua các giai đoạn xây dựng và thử nghiệm của quy trình CI sẽ không được tự động hợp nhất vào cơ sở mã chính, do đó, quy trình đóng vai trò là bộ lọc chất lượng xung quanh cơ sở mã chính – dẫn đến ít lỗi hơn và mã chất lượng cao hơn
Tóm lại, CI là thành phần chính của mục tiêu DevOps nhằm mang lại giá trị liên tục cho khách hàng. Nó tự động hóa một phần quy trình tích hợp các thay đổi mã vào cơ sở mã và do đó thắt chặt các vòng phản hồi, từ đó làm tăng chất lượng mã và bổ sung cho phát triển lô nhỏ, mang lại nhiều lợi ích bổ sung
Triển khai CI với các hành động GitHub
GitHub Actions sử dụng một hệ thống các sự kiện và quy trình công việc để thực thi các quy trình DevOps. Ví dụ: khi một cam kết được đẩy lên chính [sự kiện kích hoạt], hãy chạy quy trình công việc xây dựng và chạy thử nghiệm đối với mã đã cam kết [quy trình công việc]
Quy trình công việc về cơ bản là một tập hợp các nhiệm vụ được thực hiện để đáp ứng với một sự kiện. Quy trình công việc được xác định trong một tệp được viết theo cú pháp YAML mà bạn đưa vào kho lưu trữ dự án của mình và theo dõi bằng kiểm soát nguồn và đẩy lên GitHub cùng với mã của bạn
Các tệp quy trình làm việc bao gồm một vài thành phần khác nhau mà tôi sẽ nhanh chóng lướt qua. Đầu tiên là sự kiện – sự kiện kích hoạt quá trình chạy quy trình công việc [e. g. khi cam kết được đẩy lên chính hoặc yêu cầu kéo được gửi]. Công việc xác định trình tự các bước. Các bước được thực hiện theo trình tự theo thứ tự mà chúng được xác định trong công việc mà chúng thuộc về; . g. một lệnh trình bao duy nhất] hoặc một hành động sẽ được chạy. Một hành động giống như một đoạn mã có thể tái sử dụng có thể chạy trên nền tảng Hành động GitHub để thực hiện các tác vụ thông thường. Nhiều hành động được cung cấp hoặc hỗ trợ bởi GitHub, ví dụ: hành động
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
Lúc đầu, thuật ngữ cho các thành phần khác nhau liên quan đến việc sử dụng các hành động GitHub có thể hơi khó hiểu, ví dụ bên dưới sẽ giúp bạn thấy các phần khớp với nhau như thế nào. Bài viết Tìm hiểu hành động GitGub này trên GitHub cũng là một hướng dẫn hữu ích
Dự án Python ví dụ
Tôi đã tập hợp một kho lưu trữ Python đơn giản để trình bày cách triển khai CI với các Tác vụ GitHub. cấu trúc của kho lưu trữ được hiển thị bên dưới
shapes
┣ .github
┃ ┗ workflows
┃ ┃ ┗ python-app.yml
┣ shapes
┃ ┣ shapes_2d.py
┃ ┣ shapes_3d.py
┃ ┗ __init__.py
┣ tests
┃ ┣ test_shapes_2d
┃ ┃ ┗ test_circle.py
┃ ┣ test_shapes_3d
┃ ┃ ┗ test_sphere.py
┣ poetry.lock
┣ pyproject.toml
┗ README.md
Có một số tệp và thư mục khác [như
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
Chúng tôi có một vài mô-đun Python bên trong thư mục
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
Chúng tôi cũng có một số mã kiểm tra bên dưới thư mục
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
name: Python package
Tệp quy trình làm việc
Bên trong thư mục
name: Python package
name: Python package
name: Python package
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
Hãy xem qua tệp quy trình công việc này từng bước
name: Python package
Chỉ định tên của dòng công việc
on: [push]
Chỉ định trình kích hoạt cho quy trình làm việc. Tôi đang sử dụng sự kiện
name: Python package
Tiếp theo,
name: Python package
name: Python package
runs-on: ubuntu-latest
Điều này chỉ định HĐH trên VM [hoặc cái mà GitHub gọi là trình chạy] mà công việc sẽ chạy là phiên bản Ubuntu mới nhất
Tiếp theo, chúng ta có
strategy:
matrix:
python-version: ["3.9", "3.10"]
Phím
name: Python package
name: Python package
name: Python package
on: [push]
on: [push]
on: [push]
Tiếp theo là khóa
on: [push]
on: [push]
Bước đầu tiên của công việc
on: [push]
- uses: actions/checkout@v3
sẽ chạy phiên bản 3 của tác vụ
on: [push]
Bước tiếp theo là
- name: Install Poetry
run: pipx install poetry
Tên của bước, 'Cài đặt thơ', sẽ xuất hiện trong trình xem chạy quy trình làm việc trên GitHub. Nó thực thi lệnh shell
on: [push]
Bước tiếp theo là
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
Ở đây tôi đang sử dụng bối cảnh gọi GitHub trong tên của bước. Ngữ cảnh là đối tượng chứa các thuộc tính chứa thông tin mà bạn có thể truy cập, trong trường hợp này tôi đang truy cập thuộc tính
on: [push]
name: Python package
Bước này sử dụng tác vụ
runs-on: ubuntu-latest
runs-on: ubuntu-latest
runs-on: ubuntu-latest
runs-on: ubuntu-latest
runs-on: ubuntu-latest
on: [push]
runs-on: ubuntu-latest
Bước tiếp theo,
- name: Install dependencies
run: poetry install
chạy
runs-on: ubuntu-latest
runs-on: ubuntu-latest
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
Bước này chạy các bài kiểm tra đơn vị được xác định trong repo
name: Python package
on: [push]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Install Poetry
run: pipx install poetry
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: "poetry"
- name: Install dependencies
run: poetry install
- name: Test with Pytest
run: poetry run pytest
- name: Lint with flake8
run: poetry run flake8
Và cuối cùng, bước này chạy kẻ nói dối qua mã
Xem quy trình công việc chạy trong GitHub
Hình ảnh trên cho thấy kết quả của một quy trình công việc duy nhất được chạy trong tab Hành động trong GitHub cho kho lưu trữ này. Khắc phục sự cố xơ vải là thông báo được thêm vào cam kết đã kích hoạt quá trình chạy quy trình công việc cụ thể này. Bạn có thể thấy rằng hai công việc, cho hai phiên bản Python khác nhau được chỉ định trong
name: Python package
Bạn cũng có thể xem các bước tạo nên công việc ['build [3. 9]' trong trường hợp này], với tên ở đây tương ứng với tên chúng tôi đã cung cấp trong tệp YAML. Mỗi bước trong số này đều có thể mở rộng trong giao diện người dùng, vì vậy bạn có thể hoàn thành công việc mà mỗi bước đã thực hiện