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

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

Ai có thể sử dụng tính năng này?

Người có quyền quản trị hoặc bảo trì kho lưu trữ có thể cấu hình nguồn xuất bản cho trang GitHub Pages.

GitHub Pages có sẵn trong các kho lưu trữ công cộng với GitHub Free và GitHub Free dành cho tổ chức, và trong các kho lưu trữ công cộng và riêng tư với GitHub Pro, GitHub Team, GitHub Enterprise Cloud và GitHub Enterprise Server. Để biết thêm thông tin, hãy xem " Kế hoạch của GitHub ".

GitHub Pages hiện sử dụng GitHub Actions để thực thi bản dựng Jekyll. Khi sử dụng nhánh làm nguồn bản dựng của bạn, GitHub Actions phải được bật trong kho lưu trữ của bạn nếu bạn muốn sử dụng quy trình làm việc Jekyll tích hợp. Ngoài ra, nếu GitHub Actions không khả dụng hoặc bị tắt, việc thêm tệp .nojekyllvào gốc nhánh nguồn của bạn sẽ bỏ qua quy trình dựng Jekyll và triển khai nội dung trực tiếp. Để biết thêm thông tin về cách bật GitHub Actions, hãy xem " Quản lý cài đặt GitHub Actions cho kho lưu trữ ".

Về việc xuất bản nguồn

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

Nếu bạn không cần bất kỳ quyền kiểm soát nào đối với quy trình xây dựng cho trang web của mình, chúng tôi khuyên bạn nên xuất bản trang web của mình khi các thay đổi được đẩy đến một nhánh cụ thể. Bạn có thể chỉ định nhánh và thư mục nào để sử dụng làm nguồn xuất bản của mình. 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ể là gốc của kho lưu trữ ( /) trên nhánh nguồn hoặc một /docsthư mục trên nhánh nguồn. Bất cứ khi nào các thay đổi được đẩy đế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 ngoài Jekyll hoặc không muốn có nhánh chuyên dụng để lưu trữ các tệp tĩnh đã biên dịch, chúng tôi khuyên bạn nên viết quy trình làm việc GitHub Actions để xuất bản trang web của mình. GitHub cung cấp các mẫu quy trình làm việc cho các tình huống xuất bản phổ biến để giúp bạn viết quy trình làm việc của mình.

Cảnh báo : Các trang GitHub Pages có sẵn công khai trên internet, ngay cả khi kho lưu trữ của trang web là riêng tư (nếu kế hoạch hoặc tổ chức của bạn cho phép). Nếu bạn có dữ liệu nhạy cảm trong kho lưu trữ của trang web, bạn có thể muốn xóa dữ liệu trước khi xuất bản. Để biết thêm thông tin, hãy xem " Giới thiệu về kho lưu trữ ".

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

1. Hãy đảm bảo rằng nhánh 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, hãy điều hướng đến kho lưu trữ của trang web bạn.

3. Dưới tên kho lưu trữ của bạn, hãy nhấp vào Cài đặt . Nếu bạn không 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 hóa" của thanh bên, hãy nhấp vào Trang .

5. Trong mục "Xây dựng và triển khai", mục "Nguồn", chọn Triển khai từ một nhánh .

6. Trong mục "Xây dựng và triển khai", hãy 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 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

Lưu ý: Nếu kho lưu trữ của bạn chứa liên kết tượng trưng, bạn sẽ cần xuất bản trang web của mình bằng quy trình làm việc GitHub Actions. Để biết thêm thông tin về GitHub Actions, hãy xem " Tài liệu GitHub Actions ".

Ghi chú :

• Nếu bạn đang xuất bản từ một nhánh và trang web của bạn chưa được xuất bản tự động, hãy đảm bảo rằng ai đó có quyền quản trị và địa chỉ email đã xác minh đã đẩy lên nguồn xuất bản.

• Các cam kết được đẩy bởi quy trình làm việc GitHub Actions sử dụng GITHUB_TOKENkhông kích hoạt bản dựng GitHub Pages.

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

Trang GitHub Pages của bạn sẽ luôn được triển khai với quy trình làm 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 làm việc CI bên ngoài "triển khai" tới GitHub Pages bằng cách cam kết đầu ra bản dựng tới gh-pagesnhánh của kho lưu trữ và thường bao gồm một .nojekylltệp. Khi điều này xảy ra, quy trình làm việc GitHub Actions sẽ phát hiện trạng thái nhánh không cần bước xây dựng và sẽ chỉ thực hiện các bước cần thiết để triển khai trang tới máy chủ GitHub Pages.

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

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

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

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

2. Dưới tên kho lưu trữ của bạn, hãy nhấp vào Cài đặt . Nếu bạn không 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 hóa" của thanh bên, hãy nhấp vào Trang .

4. Trong mục "Xây dựng và triển khai", mục "Nguồn", chọn GitHub Actions .

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

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

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

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

Khi bạn cấu hình trang web của mình để xuất bản bằng GitHub Actions, GitHub sẽ đề xuất các mẫu quy trình làm việc cho các tình huống xuất bản phổ biến. Luồng chung của quy trình làm việc là:

1. Kích hoạt bất cứ khi nào có lệnh đẩy đến nhánh mặc định của kho lưu trữ hoặc bất cứ khi nào quy trình công việc được chạy thủ công từ tab Hành động.
2. Sử dụng actions/checkouthành động này để kiểm tra nội dung kho lưu trữ.
3. Nếu trang web của bạn yêu cầu, hãy xây dựng bất kỳ tệp trang web tĩnh nào.
4. Sử dụng actions/upload-pages-artifacthành động này để tải các tệp tĩnh lên dưới dạng hiện vật.
5. Nếu quy trình công việc được kích hoạt bằng lệnh đẩy đến nhánh mặc định, hãy sử dụng actions/deploy-pageshành động để triển khai hiện vật. Bước này bị bỏ qua nếu quy trình công việc được kích hoạt bằng lệnh kéo.

Các mẫu quy trình làm việc sử dụng 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ôi trường có tên là github-pages, thì môi trường sẽ được tạo tự động. Chúng tôi khuyên bạn nên thêm quy tắc bảo vệ triển khai để chỉ nhánh mặc định mới có thể triển khai vào môi trường này. Để biết thêm thông tin, hãy xem " Quản lý môi trường để triển khai ".

Khắc phục sự cố khi xuất bản bằng quy trình làm việc GitHub Actions tùy chỉnh

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