Jekyll Deploy Action 使用指南

Jekyll Deploy Action 使用指南

jekyll-deploy-action🪂 A Github Action to deploy the Jekyll site conveniently for GitHub Pages.项目地址:https://gitcode.com/gh_mirrors/je/jekyll-deploy-action

一、项目目录结构及介绍

Jekyll Deploy Action 是一个专为部署 Jekyll 网站到 GitHub Pages 设计的 GitHub Action。尽管该项目仓库本身的目录结构未在提供的信息中详细列出，我们通常可以假设一个基于Action的开源项目会有以下基本结构：

• .github: 包含workflows目录，里面存放的是GitHub Actions的配置文件（如 build-jekyll.yml）。
• README.md: 主要的说明文件，包含了项目介绍、安装和使用方法等。
• 可能还包括了示例配置或其他辅助文件，具体取决于项目作者是否提供额外的文档或示例。

由于这是一个Action，其主要关注点在于.github/workflows中的YML文件，用于定义自动化流程，而非传统意义上应用或库的复杂目录结构。

二、项目的启动文件介绍

对于 Jekyll Deploy Action 而言，没有传统的“启动文件”这一概念，核心操作是通过GitHub Actions的工作流文件来触发的。关键文件通常是位于.github/workflows中的YML文件，例如可能命名为build-jekyll.yml。这个YML文件配置了如何执行Jekyll站点的构建和部署过程。示例配置片段如下：

name: Build and Deploy to GitHub Pages
on:
  push:
    branches:
      - main  # 或者你的默认分支
jobs:
  build_and_deploy:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Repository
      uses: actions/checkout@v2
    - name: Jekyll Deploy Action
      uses: jeffreytse/jekyll-deploy-action@v0.6.0
      with:
        repository: ${{ github.repository }}
        branch: gh-pages
        jekyll_src: /

这段配置告诉GitHub当有推送到指定分支时，自动运行这个工作流，检查代码并使用Jekyll Deploy Action进行部署。

三、项目的配置文件介绍

GitHub Actions 配置文件 (*.yml)

主要的配置不在于项目本身，而是在于使用的GitHub Actions工作流文件。这些YML文件定义了一系列步骤，包括但不限于代码检出、依赖缓存、以及调用jeffreytse/jekyll-deploy-action@v0.6.0来部署网站。特别地，with部分允许你定制该Action的行为，比如指定GitHub仓库的分支、私钥、Jekyll源目录等。

Jekyll配置文件 (_config.yml)

虽然这不是Jekyll Deploy Action的一部分，但对Jekyll站点至关重要。Jekyll站点通常有一个_config.yml文件，用来配置站点元数据，如标题、作者信息、URL基础路径等。当你使用此Action部署时，确保你的Jekyll站点已配置正确，特别是如果你依赖于特定的配置选项或插件。

总结起来，Jekyll Deploy Action的使用更多地聚焦于GitHub Actions的配置，而不是项目内部的具体文件结构。确保遵循提供的YML模板并在其中插入适当的参数，以适应你的Jekyll站点需求。

jekyll-deploy-action🪂 A Github Action to deploy the Jekyll site conveniently for GitHub Pages.项目地址:https://gitcode.com/gh_mirrors/je/jekyll-deploy-action