(改进版)自动同步代码

上一篇文章,跟大家分享了一下如何让你的mac自动同步代码

但是在实际应用中发现会有点儿小问题,比如说:

  • 如果某一个分支同步失败,会直接退出当前任务,剩下的分支要自己同步。
  • 异步抓取错误,导致同步信息不好抓取。
  • 使用了 fs 来将错误信息录入到提醒文件中,每次处理的都是覆盖式写入,所以会导致查看不及时,日志丢掉的问题。

本着负责到底的原则,这里跟大家再分享一个改进版。用来改进这些问题。

1. 改进点

首先我们来看下改进点:

  • 使用 shell 命令来追加错误日志。
  • 使用 spawnSync 代替 spawn 来实现同步执行 rebase 任务
  • 分支同步出现问题后,使用git rebase --abort 来退出同步,并写入错误日志。

有了改进点,明确了修改点之后,我们来继续看下如何实现这些修改点

2. 改进点实现

2.1 使用模块

之前我们使用了 fsspawn 来实现这个功能。现在我们只需要使用 spawnSync 就可以

栗子:

const spawnSync = require("child_process").spawnSync;

2.2 项目目录和配置

这两项保持不变,还是之前的配置,还是之前的配方

栗子:

// 项目所在文件夹
const rootDir = '/Users/yancy/dev'
// 日志文件
const logFile = '/Users/yancy/Desktop/代码rebase出现问题-请及时查看.txt'
// 配置文件
const pullConfig = [
  {
    dirName: 'test', // 项目
    branchList: [ // 分支列表
      'test1',
      'test2',
    ]
  }
]

2.3 同步代码

遍历配置文件,并通过 spawnSync 来执行shell 和 git 命令。以此来同步代码

栗子:

pullConfig.forEach(item => {
  if (item.branchList.length) {

    item.branchList.forEach((branch, index) => {

      let shell = getShell(item.dirName, branch)

      let ls = spawnSync(shell, { shell: true }); // 需要注意

      checkGit(ls.stdout.toString(), item.dirName, branch)
    })
  }
})

function getShell(dirName, branch) {
  return `
        cd ${rootDir}/${dirName};
        git checkout ${branch};
        git pull origin master --rebase;
      `
}

注意点:

  • 上次我们使用spawn来执行命令,返回的ls.stdout 和 ls.stderr 是一个对象,可以使用监听事件的方式来获取执行结果。
  • 本次使用 spawnSync 来执行命令。返回的 ls.stdout 和 ls.stderr 这两个内容本来就是一个Buffer。所以可以直接通过 toString() 转换为字符串。

2.4 检查错误和后续操作

检查错误还是之前的版本。通过检查错误关键词来判断是否同步成功

栗子:

function checkGit (str, dirName, branch) {
  console.log(str)
  if (!(
    ['error', 'failed', 'git rebase --abort', 'git rebase --continue'].every(item => str.indexOf(item) === -1)
  )) {
    const logMsg = getErrorMsg(dirName, branch, str)
    // 改进点
    spawnSync(`echo '${logMsg}' >> ${logFile}`, {shell: true})
    // 改进点
    spawnSync(resetShell(dirName, branch, 'git rebase --abort'), {shell: true})
  } else {
    // 改进点
    spawnSync(resetShell(dirName, branch, `git push origin ${branch} -f`), {shell: true})
  }
}

说明:

  • 通过 echo msg >> 日志文件 的方式来追加式的写入错误信息。

    • >> 为向某个文件追加内容。这里意思指的是:将 msg 这个信息追加到日志文件中。
  • 如果查找到了错误关键词,接下来通过git rebase --abort 来回退同步。

    • 这里没有了 process.exit() 所以回退之后会进行下一个分支的同步工作。
  • 同步成功,使用 git push origin 分支 -f 来强制推送。(需要大家注意的是要养成及时推送代码的习惯,否则推送会出现问题)

3. crontab配置

实现修改成功后,下面我们需要使用 crontab 来定时执行同步代码的任务。

之前我们是使用 * 8 * * 1-5 node /Users/username/rebase.js 这种方式。但是这种方式如果配置不好会出现执行不成功的问题,所以本次换个方式实现。

现在我们使用 .sh 文件的形式来实现。首先创建一个 rebase.sh 文件
#! /bin/bash
source /etc/profile # 添加全局配置文件
node /Users/username/rebase.js # 使用node来执行 rebase 文件

.sh文件写完之后,我们通过 chmod 777 rebase.sh 来修改文件权限。否则会出现不能执行的情况。

然后我们使用 crontab -e 来编写定时任务

对于 crontab的使用方法我们在上篇文章中介绍过,本次就不再赘述了。

0 8 */1 * * ~/rebase.sh # 通过定时任务执行 rebase.sh 这个脚本文件。

注意: 测试情况下可以使用 */1 * * * * ~/rebase.sh 来节省时间

4. 完整代码演示

4.1 rebase.js

const spawnSync = require("child_process").spawnSync;

const rootDir = '/Users/yancy/dev'
const logFile = '/Users/yancy/Desktop/代码出现问题-请及时查看.txt'

const pullConfig = [
  {
    dirName: 'test',
    branchList: [
      'test1',
      'test2',
    ]
  }
]

function getShell(dirName, branch) {
  return `
        cd ${rootDir}/${dirName};
        git checkout ${branch};
        git pull origin master --rebase;
      `
}
function resetShell(dirName, branch, more) {
  return `
        cd ${rootDir}/${dirName};
        git checkout ${branch};
        ${more};
        `
}
// 自己添加的报错信息,因为比较简单,所以没说明。
function getErrorMsg (dirName, branch, str) {
  const date = new Date()
  const year = date.getFullYear()
  const month = date.getMonth() + 1
  const day = date.getDate()
  const week = date.getDay()
  const hour = date.getHours()
  const minute = date.getMinutes()
  const second = date.getSeconds()

  const time = `\n${year}-${month}-${day},周${week},${hour}:${minute}:${second}\n`
  return `${time}项目:${dirName},分支为:${branch}; \n错误信息:${str}`
}

pullConfig.forEach(item => {
  if (item.branchList.length) {

    item.branchList.forEach((branch, index) => {

      let shell = getShell(item.dirName, branch)

      let ls = spawnSync(shell, { shell: true });

      checkGit(ls.stdout.toString(), item.dirName, branch)
    })
  }
})

function checkGit (str, dirName, branch) {
  console.log(str)
  if (!(
    ['error', 'failed', 'git rebase --abort', 'git rebase --continue'].every(item => str.indexOf(item) === -1)
  )) {
    const logMsg = getErrorMsg(dirName, branch, str)
    spawnSync(`echo '${logMsg}' >> ${logFile}`, {shell: true})
    spawnSync(resetShell(dirName, branch, 'git rebase --abort'), {shell: true})
  } else {
    spawnSync(resetShell(dirName, branch, `git push origin ${branch} -f`), {shell: true})
  }
}

function runSpawn (shell) {
  spawnSync(shell, {shell: true})
}

4.2 rebase.sh

#! /bin/bash
source /etc/profile # 添加全局配置文件
node /Users/username/rebase.js # 使用node来执行 rebase 文件

4.3 crontab

0 8 */1 * * ~/rebase.sh

好了,我们本期的分享就到这里了,有兴趣的小伙伴可以尝试自己实现下。

下次再见,Bye~

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349