Hexo gitalk 极简初始化脚本
- 无需安装其他的依赖，让你的hexo项目更干净
- 不需要依赖或修改sitemap
- 更适合自动化
- 代码强迫症福音
在 GitHub workflows 通常只需增加一个 GITALK_INIT stage, 并且只需添加 GITALK_TOKEN (Personal access token) 环境变量, 就会在 {owner}.github.io 中初始化gitalk
[Token 生成请看](./README.md#Personal access token 怎么生成)
- name: GITALK_INIT
run: |
if [[ $(wget https://raw.githubusercontent.com/attson/hexo-gitalk-init/v1.0.3/gitalk_init.js && cat gitalk_init.js | md5sum | cut -d ' ' -f 1) = "c1cfe5265d8edb746489f8a9d2c499aa" ]]; then
GITALK_TOKEN=${{ secrets.BUILD_GITHUB_IO_GITALK }} node gitalk_init.js
else
echo "check md5 fail."
exit 1
fi或者下载该脚本在项目中
- name: GITALK_INIT
run: GITALK_TOKEN=${{ secrets.BUILD_GITHUB_IO_GITALK }} node gitalk_init.js| 字段 | 说明 | 默认值（env存在，则默认使用env的值） | 说明 |
|---|---|---|---|
| username | GitHub repository 所有者 (必填) | process.env.GITHUB_REPOSITORY_OWNER | GitHub repository 所有者，可以是个人或者组织。对应Gitalk配置中的owner |
| repo | 储存评论issue的github仓库名 | process.env.GITALK_INIT_REPO || ${this.username}.github.io |
储存评论issue的github仓库名，仅需要仓库名字即可。对应 Gitalk配置中的repo |
| token | GitHub 的 Personal access token (必填) | process.env.GITALK_TOKEN | 从 GitHub 的 Personal access tokens 页面，点击 Generate new token |
| enableCache | 是否启用缓存 | process.env.GITALK_INIT_CACHE || true | 是否启用缓存，启用缓存会将已经初始化的数据写入配置的 outputCacheFile 文件，下一次直接通过缓存文件 outputCacheFile 判断 |
| cacheFile | 缓存文件输出的位置 | process.env.GITALK_INIT_CACHE_FILE || path.join(__dirname, './public/gitalk-init-cache.json') |
|
| cacheRemote | 获取缓存的远程地址 | process.env.GITALK_INIT_CACHE_REMOTE || https://${this.repo}/gitalk-init-cache.json |
只用于获取缓存的来源，缓存仍然会写到 cacheFile. 读取优先级 cacheFile > cacheRemote. 故cacheFile文件存在时，忽略 cacheRemote |
| postsDir | hexo posts 文件路径 | process.env.GITALK_INIT_POSTS_DIR || 'source/_posts' |
- repo: 在不提供时, 会使用 ${username}.github.io
- cacheRemote: 在不提供时, 会使用 https://${repo}/gitalk-init-cache.json`
# 在github workflows 中, 可以省略 GITHUB_REPOSITORY_OWNER, github默认会注入 GITHUB_REPOSITORY_OWNER
# https://docs.github.com/en/actions/learn-github-actions/environment-variables
export GITHUB_REPOSITORY_OWNER=attson
export GITALK_INIT_REPO=attson.github.io
export GITALK_TOKEN=<GITALK_TOKEN>如果不喜欢使用环境变量，或者给定的环境变量名称不匹配，可以使用 json 文件，配置所需参数
在执行目录增加 gitalk_init.json
{
"username": "attson",
"repo": "attson.github.io",
"token": "<GITALK_TOKEN>",
}json 文件支持使用process.env 占位, 在 process.env.name 前后增加 {}
{
"username": "{process.env.GITHUB_REPOSITORY_OWNER}",
"repo": "{process.env.GITHUB_REPOSITORY_OWNER}.github.io",
"token": "{process.env.GITALK_TOKEN}",
}本地json文件
curl -sL https://raw.githubusercontent.com/attson/hexo-gitalk-init/v1.0.3/gitalk_init.js | node
从 GitHub 的 Personal access tokens 页面，点击 Generate new token
在的git workflows 运行的仓库增加 secrets
- 本脚本代码由 https://blog.jijian.link/2020-01-10/hexo-gitalk-auto-init/ 改造而来。原作者脚本需增加依赖
request xml-parser blueimp-md5 moment hexo-generator-sitemap - 本脚本默认使用下面的方式一下的方式生成 gitalkId
(pathname, title, desc, date) => {
let id = pathname
// github issue label max 50
if (id.length > 50) {
id = id.substring(0, 50 - 3) + '...'
}
return id
}不同的主题可能使用不同的生成方式，请检查主题的代码中gitalkId生成逻辑, 是否一致。
不一致可以在执行目录增加 get-gitalk-id.js, 可以替代默认生成方式
function getGitalkId(pathname, title, desc, date) {
let id = pathname
// github issue label max 50
if (id.length > 50) {
id = id.substring(0, 50 - 3) + '...'
}
return id
}
module.exports = {
getGitalkId
}