持续集成相关操作步骤整理:

目的

通过持续集成的方式, 当github上的源码项目发生push tag动作时, 自动编译生成可执行程序和安装包, 并传回github releases供用户使用

介绍:

操作步骤分为两个平台: windows(使用appveyor)和mac(使用travis), 因为一次代码和tag提交会生成一份指定编号的release,而两个平台使用不同的ci服务,当有新tag时,会造成两个ci服务都往github releases推送相同release编号的生成包,造成第二次推送失败, 所以建议两个平台项目分开

Sample

流程

windows平台:

appveyor注册帐号
将github项目加入appveyor
从https://github.com/settings/tokens获取token
使用appveyor官网工具(Link)加密上一步的token
在项目根目录下编写配置文件appveyor.yml,将auth_token键名后添加上一步的加密后字符串

environment:
  nodejs_version: "6"
  skip_tags: false

install:
  - npm install
  - ./node_modules/.bin/webpack -p
  - npm run build

build: off

build_script:
  - ./node_modules/.bin/build --config ./electron-builder.yml --win

test: off

artifacts:
  - path: ./dist/testApp*
    name: testApp

deploy:
  - provider: GitHub
    artifact: testApp
    draft: false
    prerelease: false
    
    auth_token:
      secure: 'vj997csmzYo+h1Vf9o87CjWj18njqemEDUfhGMqLjPpGYlsgD1IXlmhVGGJbzG31'
      
    on:
      appveyor_repo_tag: true

注意：键artifacts->name的值和deploy->atrifact的值必须一致

在shell环境下执行git相关命令，创建新的tag标签

git add ...
git commit ...
git tag -a v?.?.?
git push origin master --tag

appveyor页面随即提示有新的build,等待操作完成后,访问github releases页面即可发现最新生成包
appveyor向github推送build完成的文件包时, 需要在appveyor的页面上加入环境变量appveyor_repo_tag和GH_TOKEN, 现阶段发现appveyor.yml中配置appveyor_repo_tag变量无效, 只有加在网页页面配置项中才起作用
注意: 如果使用electron-builder工具的auto-update功能, 则建议不要使用appveyor的deploy功能, 而是使用electron-builder的cli工具中的-p (--publish)功能向github推送新生成的文件包 (即./node_modules/.bin/build --config ./electron-builder.yml -p always --win), 否则现阶段发现使用appveyor推送到github上的文件包缺少latest.yml文件, just like

  environment:
    nodejs_version: "6"
    skip_tags: false

  install:
    - npm install
    - npm uninstall babel
    - npm install babel-cli
    - npm install electron-builder --save-dev
    - npm install electron-log electron-updater --save
    - ./node_modules/.bin/webpack -p
    - npm run build

  build: off

  build_script:
    - ./node_modules/.bin/build --config ./electron-builder.yml --win -p always

  test: off

macos平台:

travis注册帐号
将github项目加入travis
在项目根目录编写.travis.yml配置文件

备注: 此时的配置文件只是包含部分内容, 需要后续步骤补充修改

重要: 配置文件中的osx_image字段现阶段指定为xcode8, 不要使用更高版本，否则travis在build时, code signing环节会报错

### 配置文件内容 ###
sudo: true
language: node_js
node_js: '6'
os: osx
osx_image: xcode8

branches:
  except:
  - master

before_install:
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; fi

install:
  - npm install
  - "./node_modules/.bin/webpack -p"
  - npm run build

script:
  - "./node_modules/.bin/build --config ./electron-builder.yml --mac"

从https://github.com/settings/tokens获取token
安装travis官网工具

### 安装工具 ###
sudo apt-get install python-software-properties
sudo apt-add-repository ppa:brightbox/ruby-ng
sudo apt-get update
sudo apt-get install ruby2.1 ruby2.1-dev ruby-switch
sudo ruby-switch --set ruby2.1
sudo gem install travis -v 1.8.8 --no-rdoc --no-ri

使用travis工具 travis setup releases

备注: 该命令包含用户交互界面, 根据项目具体信息填写相关问题, 有一步需要将前面的token填入进去
上步骤完成后, .travis.yml配置文件被工具自动修改, 增添了deploy字段, 在此基础上继续完善该文件

sudo: true
language: node_js
node_js: '6'
os: osx
osx_image: xcode8

branches:
  except:
  - master

before_install:
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; fi

install:
  - npm install
  - "./node_modules/.bin/webpack -p"
  - npm run build

script:
  - "./node_modules/.bin/build --config ./electron-builder.yml --mac"

deploy:
  provider: releases
  prerelease: false
  api_key:
    secure: dDAbiCuWnsTQRhjMQAPxg2gvcRJ2FD9OUuU4Yyg7SRBMFYv/Wld9W/E1hPdmvgWgJpSJ5Z/KBksSxTZslQejsnmC9cPJ8yiDuBgcLjWp8TXtvS7kAYhPZub3CErORUVhkyn3U6Zk9l9jEqxkNkXwQckIpzX5OGV/69BlD24So0g3nHY22MnGkegXkfO4EWvSmdqouFvEujjG/EuglFqAnu8YgW5p3f5r8YTJavCQE7UpyaTE4cekmi2pbpZ1absjD0FTItfUbliXdR5eR9FQcx3vmtyGpIosye0JjJUxgeAq8At7DYoXg+9o08Nk69mSDZVPlYqNC8AOIGQgTqoutJoo04HA96xJITm/WcSlPGrHkov5L3Xzw4zjuHeJSQpxEAin9ovY647mmO03VgLDLC0c/XAhW2t7Hp0NmZ8NP6Yg7mnlv68/iF+Y/ZYfOJJyesocYCPoEWmJZH9nwDSCOcTBRjLC6E1SGGojhETAjJvZX8D5LhTrCPzG+XV55AbaurDYg4r72CvW7Fij40XgVCSm6yMUMAP38k4ukwrdXnnScNZgXESFDQUsOBDOqbIcGrW4vMIlTKmDCQ7Td5nXLjbDkZaP0ckEQ/cYuAXBBvLlv5y3/11tlcHqRqORV3IkLQLxAckO9kZqEF4h2SPrS7EmuxoFfVc2ZyUBmMsfnkc=
  file: dist/testApp-1.0.0.dmg
  skip_cleanup: true
  on:
    repo: JiangWeiGitHub/wisnucAssistant-mac
    tags: true

为了code signing, 先在MAC主机上导出证书，具体操作参看下列示例

1. Open Keychain.

2. Select login keychain, and My Certificates category.

3. Select all required certificates (hint: use cmd-click to select several):

    3.1 Developer ID Application: to sign app for macOS.
 
    3.2 3rd Party Mac Developer Application: and 3rd Party Mac Developer Installer: to sign app for MAS (Mac App Store).
 
    3.3 Developer ID Application: and Developer ID Installer to sign app and installer for distribution outside of the Mac App Store.
 
    Please note – you can select as many certificates, as need. No restrictions on electron-builder side. All selected certificates will be imported into temporary keychain on CI server.

4. Open context menu and Export.

备注: 记住导出时使用的密码

将生成的p12加入github源码池中, 并记录好该文件的https地址, 如Sample File
在travis的项目页面上点击More options->Settings, 在Environment Variables下增加两个字段CSC_LINK, CSC_KEY_PASSWORD, CSC_LINK字段的值即为上一步的p12文件的https地址, CSC_KEY_PASSWORD即为导出p12文件时输入的密码
在shell环境下执行git相关命令，创建新的tag标签

git add ...
git commit ...
git tag -a v?.?.?
git push origin master --tag

travis页面随即提示有新的build, 等待操作完成后, 访问github releases页面即可发现最新生成包
注意: 如果使用electron-builder工具的auto-update功能, 则建议不要使用travis的deploy功能, 而是使用electron-builder的cli工具中的-p (--publish)功能向github推送新生成的文件包 (即./node_modules/.bin/build --config ./electron-builder.yml -p always --mac), 否则现阶段发现使用travis推送到github上的文件包缺少latest-mac.json文件, just like

  sudo: true
  language: node_js
  node_js: '6'
  os: osx
  osx_image: xcode8

  branches:
    except:
    - master

  before_install:
    - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; fi

  install:
    - npm install
    - npm uninstall babel
    - npm install babel-cli
    - npm install electron-builder --save-dev
    - npm install electron-log electron-updater --save
    - ./node_modules/.bin/webpack -p
    - npm run build

  script:
    - "./node_modules/.bin/build --config ./electron-builder.yml --mac -p always"

  #deploy:
  #  provider: releases
  #  prerelease: false
  #  api_key:
  #    secure: dDAbiCuWnsTQRhjMQAPxg2gvcRJ2FD9OUuU4Yyg7SRBMFYv/Wld9W/E1hPdmvgWgJpSJ5Z/KBksSxTZslQejsnmC9cPJ8yiDuBgcLjWp8TXtvS7kAYhPZub3CErORUVhkyn3U6Zk9l9jEqxkNkXwQckIpzX5OGV/69BlD24So0g3nHY22MnGkegXkfO4EWvSmdqouFvEujjG/EuglFqAnu8YgW5p3f5r8YTJavCQE7UpyaTE4cekmi2pbpZ1absjD0FTItfUbliXdR5eR9FQcx3vmtyGpIosye0JjJUxgeAq8At7DYoXg+9o08Nk69mSDZVPlYqNC8AOIGQgTqoutJoo04HA96xJITm/WcSlPGrHkov5L3Xzw4zjuHeJSQpxEAin9ovY647mmO03VgLDLC0c/XAhW2t7Hp0NmZ8NP6Yg7mnlv68/iF+Y/ZYfOJJyesocYCPoEWmJZH9nwDSCOcTBRjLC6E1SGGojhETAjJvZX8D5LhTrCPzG+XV55AbaurDYg4r72CvW7Fij40XgVCSm6yMUMAP38k4ukwrdXnnScNZgXESFDQUsOBDOqbIcGrW4vMIlTKmDCQ7Td5nXLjbDkZaP0ckEQ/cYuAXBBvLlv5y3/11tlcHqRqORV3IkLQLxAckO9kZqEF4h2SPrS7EmuxoFfVc2ZyUBmMsfnkc=
  #  file_glob: true
  #  file: dist/*
  #  skip_cleanup: true
  #  on:
  #    repo: JiangWeiGitHub/fruitmix-desktop-mac
  #    tags: true

electron-builder向github推送build完成的文件包时, 需要在travis的页面上加入环境变量GH_TOKEN
警告: 使用electron-builder.yml时, 一定要加上zip字段, 否则latest-mac.json不会生成, 配置如下:

    appId: com.wisnuc.app
    copyright: wisnuc
    productName: testApp

    asar: false

    directories:
      buildResources: /
      output: dist/

    files:
      - "**/*"

    dmg:
      contents:
        - type: link
          path: /Applications
          x: 410
          y: 150
        - type: file
          x: 130
          y: 150

    mac:
      target:
        - dmg
        - zip
      category: public.app-category.tools

    win:
      target: nsis

    linux:
      target:
        - deb
        - AppImage

electron-updater使用

Wiki Site

源码如下:

  ...
  ...
  
  import { autoUpdater } from 'electron-updater'
  import log from 'electron-log'

  ...
  ...

  app.on('ready', function() {

    ...
    ...
  
    autoUpdater.checkForUpdates()

    ...
    ...
  }

  ...
  ...
  

  autoUpdater.logger = log;
  autoUpdater.logger.transports.file.level = 'info';
  log.info('App starting...');

  var sendStatusToWindow = text => {
    log.info(text)
    getMainWindow().webContents.send('message', text)
  }

  autoUpdater.on('checking-for-update', () => {
    sendStatusToWindow('Checking for update...')
  })

  autoUpdater.on('update-available', (ev, info) => {
    sendStatusToWindow('Update available.')
  })

  autoUpdater.on('update-not-available', (ev, info) => {
    sendStatusToWindow('Update not available.')
  })

  autoUpdater.on('error', (ev, err) => {
    sendStatusToWindow(err)
    sendStatusToWindow('Error in auto-updater.')
  })

  autoUpdater.on('download-progress', (ev, progressObj) => {
    sendStatusToWindow('Download progress...')
  })

  autoUpdater.on('update-downloaded', (ev, info) => {
    sendStatusToWindow('Update downloaded; will install in 5 seconds')
  })

  ...
  ...

Name		Name	Last commit message	Last commit date
Latest commit History 158 Commits
README.md		README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Repository files navigation

持续集成相关操作步骤整理:

目的

介绍:

Sample

流程

windows平台:

macos平台:

electron-updater使用

About

Releases 8

Packages

JiangWeiGitHub/CISample

Folders and files

Latest commit

History

README.md

README.md

Repository files navigation

持续集成相关操作步骤整理:

目的

介绍:

Sample

流程

windows平台:

macos平台:

electron-updater使用

About

Topics

Resources

Stars

Watchers

Forks

Releases 8

Packages 0

Packages