【主题开发】使用 shell 脚本来自动化提交思源笔记集市

本贴最后更新于 1176 天前,其中的信息可能已经时移世改

update_time:2021-10-03 17:38 Sun

由于我目前在思源笔记集市需要维护四个主题,且每次更新基本是需要同时更新四个主题的,如果按手动的方法,我需要

  1. 先把修改提交到自己的主题 repo,push 到 github
  2. 一个主题一个主题复制 40 位的 commit SHA-1 码,一个个修改 bazaar 里的 themes.json

这样维护主题起来就很麻烦了,而且每次提交我害怕把不同主题的 SHA-1 搞混搞漏,还需要校对一下。

无奈,正好最近在接触 shell 脚本,就打算用 shell 写一个自动化提交到集市的脚本

主要功能大概是

  1. 由于我的主题 repo 都是 siyuan-themes 开头,且都放在 conf/themes 文件夹下,于是希望脚本可以识别我的主题 repo,然后批量把修改上传到 github。
  2. 各个主题生成 SHA-1 码,生成一个 temp.json 文件,这样我可以直接把生成的 json 内容手动替换 bazaar 的 json,这样也不错。
  3. 要是可以一步到位,直接修改 bazaar 中 json 内对应我 repo 的文字内容,直接提交就好啦。这样我只负责修改主题,主题一修改好,确定没问题,直接运行脚本就好。

结果嘛……看起来还不错


先展示下我的工作区,工作区就在 conf/themes, 我把 bazaar 和自己的主题 repo 都 clone 到了 themes 文件内,后面脚本都是按照这个文件目录编排来的,当然你可以根据自己的需要修改脚本。

image.png

接下来简要介绍下我的脚本

1_repo_commit.sh

对应第一点需求,识别 siyuan-themes 开头的文件夹,然后提交修改,push 到 Github

echo -e "\e[1;31m\nRun 1_repo_commit.sh\n\e[0m" 
cd ../
HOME=`pwd`
message=":bookmark: v0.8.7"
find ${HOME} -maxdepth 1 -type d -name "siyuan-themes*" | while read repo;
    do  
        echo -e "\e[1;31mCommitting\e[0m" $repo
        cd $repo
        echo `pwd`
        git add -A
        git commit -m "${message}"
        git push origin main
        echo -e "done\n"
done

2_get_sha1.sh

对应第二点需求,主题提交完成后,生成 temp.json 文件,得到 "repo_name@SHA-1" 格式的内容

#!/bin/bash

# into the upper folder
cd ../

HOME=`pwd`

# generate json
echo -e "\e[1;36m\ntemp.json.json started generating\n\e[0m"
echo "" > ${HOME}/temp.json
echo -e "{ \n    \"repos\": [" >> ${HOME}/temp.json

# find + absolute path -> return absolute path
find ${HOME} -maxdepth 1 -type d -name "siyuan-themes*" | while read repo;
    do  
        cd $repo
        # rexp: (?<=exp) match after the exp
        # grep : -P use regular expression,-o print the matched parts
        # git rev-parse HEAD -> get the latest SHA-1
        git remote -v | tail -n 1 | grep -P "(?<=github.com\/)[^\.]+" -o | xargs -i echo "    \"{}@`git rev-parse HEAD`\","  

done >> ${HOME}/temp.json

echo -e "    ] \n}" >> ${HOME}/temp.json

# info
echo -e "\e[1;36m\ntemp.json.json generated successfully\n\e[0m"

3_siyuan_bazaar.sh

对应第三点需求,直接修改 bazaar 中自己 repo 的对应行内容,并提交修改 push 到 Github。有这个脚本,其实第二个脚本就可以不用跑了,但为了保险起见,还是需要单独生成一个 temp.json。万一 bazaar 给我改坏了咋办???

#!/bin/bash
# set commit message
message=":lipstick: Update Tsundoku v0.8.7"

# set path
cd ..
BAZAAR=`pwd`/bazaar
HOME=`pwd`


# update remote repo to local
cd ${BAZAAR}
git restore .
git pull

# change bazaar json
echo -e "\e[1;34m\nchanging theme.json in bazaar\n\e[0m"
find ${HOME} -maxdepth 1 -type d -name "siyuan-themes*" | while read repo;
    do  
        cd $repo
        # rexp: (?<=exp) match after the exp
        # grep : -P use regular expression,-o print the matched parts
        name=`git remote -v | tail -n 1 | grep -P "(?<=github.com\/)[^\.]+" -o`
        # git rev-parse HEAD -> get the latest SHA-1
        sha1=`git rev-parse HEAD`
        sed -i "s|${name}@[^\"]*|"${name}@${sha1}"|g" ${BAZAAR}/themes.json 
        echo -e "\e[1;34m\n...\n\e[0m"
done 


# git commit and push 
cd ${BAZAAR}
git add -A
git commit -m "${message}"
git push
echo -e "\e[1;34m\npushed to bazaar over\n\e[0m"

main.sh

最后,main.sh 就是直接跑三个脚本啦

#!/bin/bash
bash ./1_repo_commit.sh
bash ./2_get_sha1.sh
bash ./3_siyuan_bazzar.sh

结束

GitHub 地址:Achuan-2/siyuan-commit-scripts: shell script for siyuan bazzar commit (github.com)

  • 思源笔记

    思源笔记是一款隐私优先的个人知识管理系统,支持完全离线使用,同时也支持端到端加密同步。

    融合块、大纲和双向链接,重构你的思维。

    23020 引用 • 92599 回帖
1 操作
Achuan-2 在 2021-10-03 18:01:33 更新了该帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
Achuan-2
给时间以生命而不是给生命以时间,如果你喜欢我的分享,欢迎给我买杯咖啡 https://www.yuque.com/achuan-2 武汉