Cấu hình nguồn xuất bản cho trang GitHub Pages của bạn

Giới thiệu

Bạn có thể xuất bản trang của mình khi có thay đổi được đẩy lên một nhánh cụ thể hoặc bạn có thể viết một quy trình công việc GitHub Actions để xuất bản trang của bạn.

Nếu bạn không cần kiểm soát quá trình xây dựng trang của mình, chúng tôi khuyến nghị bạn nên xuất bản trang của mình khi có thay đổi được đẩy lên một nhánh cụ thể. Bạn có thể chỉ định nhánh và thư mục để sử dụng như nguồn xuất bản của bạn. Nhánh nguồn có thể là bất kỳ nhánh nào trong kho lưu trữ của bạn và thư mục nguồn có thể hoặc là thư mục gốc của kho lưu trữ (/) trên nhánh nguồn hoặc là thư mục /docs trên nhánh nguồn. Mỗi khi có thay đổi được đẩy lên nhánh nguồn, các thay đổi trong thư mục nguồn sẽ được xuất bản lên trang GitHub Pages của bạn.

Nếu bạn muốn sử dụng quy trình xây dựng khác với Jekyll hoặc không muốn có một nhánh riêng để lưu trữ các tệp tĩnh đã biên dịch, chúng tôi khuyến nghị bạn nên viết một quy trình công việc GitHub Actions để xuất bản trang của bạn. GitHub cung cấp các quy trình công việc khởi đầu cho các tình huống xuất bản thông thường giúp bạn viết quy trình công việc của mình.

Xuất bản từ một nhánh

1. Đảm bảo rằng nhánh mà bạn muốn sử dụng làm nguồn xuất bản đã tồn tại trong kho lưu trữ của bạn.

2. Trên GitHub, điều hướng đến kho lưu trữ trang của bạn.

3. Dưới tên kho lưu trữ của bạn, nhấp vào Cài đặt. Nếu bạn không thể thấy tab "Cài đặt", hãy chọn menu thả xuống, sau đó nhấp vào Cài đặt.

4. Trong phần "Mã và tự động hoá" của thanh bên, nhấp vào Trang.

5. Dưới "Xây dựng và triển khai", dưới "Nguồn", chọn Triển khai từ một nhánh.

6. Dưới "Xây dựng và triển khai", sử dụng menu thả xuống nhánh và chọn nguồn xuất bản.

7. Tùy chọn, sử dụng menu thả xuống thư mục để chọn một thư mục cho nguồn xuất bản của bạn.

8. Nhấp vào Lưu.

Khắc phục sự cố xuất bản từ một nhánh

Nếu bạn chọn thư mục /docs trên bất kỳ nhánh nào làm nguồn xuất bản của bạn, sau đó loại bỏ thư mục /docs từ nhánh đó trong kho lưu trữ của bạn, trang của bạn sẽ không xây dựng và bạn sẽ nhận được thông báo lỗi xây dựng trang vì thiếu /docs. Để biết thêm thông tin, xem "Khắc phục lỗi xây dựng Jekyll cho trang GitHub Pages".

Trang GitHub Pages của bạn luôn được triển khai với một quy trình công việc GitHub Actions, ngay cả khi bạn đã cấu hình trang GitHub Pages của mình để được xây dựng bằng một công cụ CI khác. Hầu hết các quy trình công việc CI bên ngoài "triển khai" lên GitHub Pages bằng cách thực hiện cam kết đầu ra xây dựng vào nhánh gh-pages của kho lưu trữ và bao gồm một tệp .nojekyll. Khi điều này xảy ra, quy trình công việc GitHub Actions sẽ phát hiện trạng thái không cần thiết xây dựng nhánh và chỉ thực hiện các bước cần thiết để triển khai trang lên máy chủ GitHub Pages.

Để tìm lỗi tiềm năng về xây dựng hoặc triển khai, bạn có thể kiểm tra quy trình chạy của trang GitHub Pages của mình bằng cách xem lại các quy trình chạy của kho lưu trữ của bạn. Để biết thêm thông tin, xem "Xem lịch sử chạy quy trình công việc". Để biết thêm thông tin về cách chạy lại quy trình công việc trong trường hợp xảy ra lỗi, xem "Chạy lại quy trình công việc và công việc".

Xuất bản với quy trình công việc GitHub Actions tùy chỉnh

Để cấu hình trang của bạn để xuất bản bằng GitHub Actions:

1. Trên GitHub, điều hướng đến kho lưu trữ trang của bạn.

2. Dưới tên kho lưu trữ của bạn, nhấp vào Cài đặt. Nếu bạn không thể thấy tab "Cài đặt", hãy chọn menu thả xuống, sau đó nhấp vào Cài đặt.

3. Trong phần "Mã và tự động hoá" của thanh bên, nhấp vào Trang.

4. Dưới "Xây dựng và triển khai", dưới "Nguồn", chọn GitHub Actions.

5. GitHub sẽ đề xuất một số quy trình công việc khởi đầu. Nếu bạn đã có một quy trình công việc để xuất bản trang của bạn, bạn có thể bỏ qua bước này. Ảo không, chọn một trong các tùy chọn để tạo một quy trình công việc GitHub Actions. Để biết thêm thông tin về cách tạo quy trình công việc tùy chỉnh của bạn, xem "Tạo một quy trình công việc GitHub Actions tùy chỉnh để xuất bản trang của bạn".

Cấu hình GitHub Pages không liên kết với một quy trình công việc cụ thể nào. Tuy nhiên, cài đặt GitHub Pages sẽ liên kết đến quy trình công việc chạy mới nhất triển khai trang của bạn.

Tạo một quy trình công việc GitHub Actions tùy chỉnh để xuất bản trang của bạn

Để biết thêm thông tin về GitHub Actions, xem "Tài liệu GitHub Actions".

Khi bạn cấu hình trang của mình để xuất bản với GitHub Actions, GitHub sẽ đề xuất các quy trình công việc khởi đầu cho các tình huống xuất bản thông thường. Luồng chung của một quy trình công việc là:

1. Kích hoạt mỗi khi có một lần đẩy vào nhánh mặc định hoặc mỗi khi quy trình công việc được chạy thủ công từ tab Hành động.

2. Sử dụng hành động actions/checkout để kiểm tra nội dung kho lưu trữ.

3. Nếu được yêu cầu bởi trang của bạn, xây dựng tệp tĩnh của trang.

4. Sử dụng hành động actions/upload-pages-artifact để tải lên các tệp tĩnh làm artifacts.

5. Nếu quy trình công việc được kích hoạt bởi một lần đẩy vào nhánh mặc định, sử dụng hành động actions/deploy-pages để triển khai artifacts. Bước này sẽ được bỏ qua nếu quy trình công việc được kích hoạt bởi một yêu cầu rút.

Các quy trình công việc khởi đầu sử dụng một môi trường triển khai có tên là github-pages. Nếu kho lưu trữ của bạn chưa bao gồm một môi trường có tên là github-pages, môi trường sẽ được tạo tự động. Chúng tôi khuyến nghị bạn nên thêm một quy tắc bảo vệ triển khai để chỉ nhánh mặc định có thể triển khai vào môi trường này. Để biết thêm thông tin, xem "Sử dụng môi trường để triển khai".

Khắc phục sự cố xuất bản với quy trình công việc GitHub Actions tùy chỉnh

Để biết thông tin về cách khắc phục sự cố trong quy trình công việc GitHub Actions của bạn, hãy xem "Về giám sát và khắc phục sự cố".