Bạn có thể sử dụng Màu đen trong quy trình làm việc của GitHub Actions mà không cần thiết lập môi trường Python của riêng bạn. Tuyệt vời để thực thi rằng mã của bạn phù hợp với kiểu mã Đen
Khả năng tương thích#
Hành động này được biết là hỗ trợ tất cả các hệ điều hành người chạy được lưu trữ trên GitHub. Ngoài ra, chỉ các phiên bản Black được xuất bản mới được hỗ trợ (i. e. bất cứ thứ gì có sẵn trên PyPI)
Cuối cùng, hành động này cài đặt Đen với phần bổ sung colorama để cờ --color hoạt động tốt
Cách sử dụng#
Tạo một tệp có tên .github/workflows/black.yml bên trong kho lưu trữ của bạn với
name: Lint on: [push, pull_request] jobs: lint: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: psf/black@stable
Chúng tôi khuyên bạn nên sử dụng thẻ @stable, nhưng thẻ theo phiên bản cũng tồn tại nếu bạn thích điều đó. Lưu ý rằng phiên bản của hành động bạn chọn độc lập với phiên bản Đen mà hành động sẽ sử dụng
Phiên bản Đen mà hành động sẽ sử dụng có thể được định cấu hình qua - uses: psf/black@stable with: options: "--check --verbose" src: "./src" jupyter: true version: "21.5b1" 0. Đây có thể là bất kỳ công cụ xác định phiên bản hợp lệ nào hoặc chỉ là số phiên bản nếu bạn muốn có một phiên bản chính xác. Hành động mặc định cho bản phát hành mới nhất có sẵn trên PyPI. Chỉ các phiên bản có sẵn từ PyPI mới được hỗ trợ, vì vậy không có SHA cam kết hoặc tên chi nhánh
Nếu bạn muốn bao gồm Máy tính xách tay Jupyter, Màu đen phải được cài đặt với phần bổ sung - uses: psf/black@stable with: options: "--check --verbose" src: "./src" jupyter: true version: "21.5b1" 1. Việc cài đặt các tệp Jupyter Notebook bổ sung và bao gồm có thể được định cấu hình qua - uses: psf/black@stable with: options: "--check --verbose" src: "./src" jupyter: true version: "21.5b1" 1 (mặc định là - uses: psf/black@stable with: options: "--check --verbose" src: "./src" jupyter: true version: "21.5b1" 0)
Bạn cũng có thể định cấu hình các đối số được truyền cho Đen qua - uses: psf/black@stable with: options: "--check --verbose" src: "./src" jupyter: true version: "21.5b1" 1 (mặc định là - uses: psf/black@stable with: options: "--check --verbose" src: "./src" jupyter: true version: "21.5b1" 2) và - uses: psf/black@stable with: options: "--check --verbose" src: "./src" jupyter: true version: "21.5b1" 3 (mặc định là - uses: psf/black@stable with: options: "--check --verbose" src: "./src" jupyter: true version: "21.5b1" 4)