用 GitHub Action 🚀 在你的仓库中创建和更新网站地图。
Tip
这是 Sitemap Creator 的稳定版仓库。预发行版仓库请前往 fjwxzde/Sitemap_Creator_Pre-Release 查看。
| Sitemap | Creator | ||
|---|---|---|---|
| 无需本地操作 | ✅ | 稳定更新 | ✅ |
| 完全免费 | ✅ | 修改时区5 | ✅ |
| 指定更新/创建方式 | ✅ | 不遗漏页面 | ✅ |
| 忽略页面 | ✅ | 指定网站地图存放位置 | ✅ |
| 指定页面文件类型 | ✅ | 中文文档+输出 | ✅ |
| 更多 | 优点 | ... | ✅ |
Tip
所有参数名使用单数形式
| 参数 | 描述 | 默认值 | 是否必须 | 备注 |
|---|---|---|---|---|
location |
网站地图的存放位置 (例如 docs/sitemap.xml) |
./sitemap.xml (即仓库根目录) |
否 | / |
token |
用于创建更新网站地图的拉取请求的 Token | ${{ github.token }} |
否 | 您的 Token 至少应该具有 repo 权限来推送修改，如果使用默认的 Action Token 则需要在仓库设置中给 GitHub Action 写入权限1 |
timezone |
设置生成时使用的时区 | Asia/Shanghai (上海，UTC+8，CST，Ubuntu/Macos格式) |
否 | 请依据您的 Runner 设置该参数5 |
basic_link |
指向你网站的基础链接 | https://${{ github.event.repository.owner.login }}.github.io/${{ github.event.repository.name }} |
否 | / |
file_type |
网页文件的类型 (例如使用 docsify 部署的就是 md，可指定多个类型) | html,md |
否 | 不带.，md类型会自动去掉后缀名 |
ignore_file |
指定哪些文件不包含在网站地图中 | 啥都没有 |
否 | ,间隔 |
website_path |
你的网站内容的位置 (例如 ./ (根目录) 或 docs) |
./ (根目录) |
是 | / |
base_branch |
仓库主分支 (main，master 等) |
main |
否 | / |
label |
创建拉取请求时添加的标签 | / | 否 | 会自动移除'、"、`，可以设置debug: true来查看运行情况，标签间用,分隔 |
reviewer |
创建拉取请求时指定的审查者 | / | 否 | 会自动鉴权，如果指定的审查者不是仓库的协作者则无法添加 |
author_name |
更新提交的撰写者名 | github-actions[bot] |
否 | 这里指定的是提交的撰写者的名称，不是拉取请求的创建者的名称。拉取请求的创建者为 Token 所有者 |
author_email |
更新提交的撰写者邮箱 | 41898282+github-actions[bot]@users.noreply.github.com (不知道从哪找来的 GitHub Action [bot] 的邮箱) |
否 | 这里指定的是提交的撰写者的邮箱，不是拉取请求的创建者的邮箱。拉取请求的创建者为 Token 所有者 |
auto_merge |
启用自动合并的方式 (不指定则不启用自动合并) | / | 否 | 可用的自动合并方式，什么是自动合并 |
update |
指定更新网站地图的方式 (直接提交或拉取请求) | 拉取请求 |
否 | 可用的参数值 |
debug |
控制调试输出的开关 | false |
否 | 你用true还是1随便，js里真值2的都行 |
打开仓库 Settings (上方栏) > Code and automation (左侧栏) > Actions (左侧栏子类别) > General (子类别) > Workflow permissions (划到最下面):
如果你希望进行更精细的访问控制，你可以在你的工作流中添加以下内容:
# 相关文档: https://docs.github.com/zh/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
permissions:
contents: write # 允许修改仓库内容，例如提交、发行版等
pull-requests: write # 允许创建和修改 PR，如果您使用更新方式“提交”可以不给这个权限(如果需要拉取请求的话设置中用于创建拉取请求的那个权限还是要勾下)
请见真值 - MDN Web 文档术语表：Web 相关术语的定义 | MDN。
处理时会自动去除'、"、`、-。
| 接收的输入 (去除特殊字符后) | 自动合并方式 |
|---|---|
s、squash、压缩、压缩合并、压缩自动合并 |
压缩合并 |
m、merge、合并、合并提交、提交 |
合并提交 |
r、rebase、变基、变基合并、变基自动合并 |
变基合并 |
| 空字符串 | 不启用自动合并 |
| 其他任意值 | 视作错误返回 1 |
处理时会自动去除'、"、`、-、 。
| 接收的输入 (去除特殊字符后) | 修改方式 |
|---|---|
pr、pullrequest、pullrequests、prs、拉取请求 |
创建拉取请求 (默认) |
commit、提交、直接提交、directcommit、commitdirectly |
直接提交到主分支 |
请按照您的工作流使用的 Runner 来设置时区。
| Runner OS | 查看方式 | 是否支持默认时区 |
|---|---|---|
| Windows | TZUTIL /l |
✅ |
| Linux | timedatectl list-timezones |
✅ |
| MacOS | systemsetup -gettimezone |
✅ |
注: 在 Windows Runner 上，默认的
Asia/Shanghai(亚洲/上海) 会被转为China Standard Time(中国标准时间 CST) 。
name: 生成 Sitemap
# GitHub Action DuckDuckStudio/Sitemap_Creator 版本 1.0.8 示例工作流
# https://github.com/marketplace/actions/sitemap-creator-stable
# Under the [GNU Affero General Public License v3.0](https://github.com/DuckDuckStudio/Sitemap_Creator/blob/main/LICENSE)
on:
push:
branches:
- main
# 当 main 分支上有新推送且以下文件被更改时
paths:
- '**/*.html'
- '**/*.md'
workflow_dispatch: # 手动运行
jobs:
generate_sitemap:
runs-on: ubuntu-latest
steps:
- name: 更新网站地图
uses: DuckDuckStudio/[email protected]
with:
location: "docs/sitemap.xml"
basic_link: "https://duckduckstudio.github.io/Articles/#" # docsify 部署的
ignore_file: "_Footer.md,404.html,某鸭的文章页面模板.html,营销号"
website_path: "docs"
labels: "DEV-已启用自动合并,工作流,DEV-开发分支合并"
auto_merge: "压缩合并"
debug: true # 启用调试输出
# 其他参数默认
# base_branch: "main"
# file_type: "html,md"
# token: ${{ github.token }}
# timezone: "Asia/Shanghai"
# update: "拉取请求"
# author_name: "github-actions[bot]"
# author_email: "41898282+github-actions[bot]@users.noreply.github.com"如果您认为本项目对您有帮助，还请给本项目一个小小的 Star 。