[CI] travis.ci 坑不少

[whatwewant]

格式很自由，但是一下是我比较喜欢的方式(.travis.yml)

language: node_js
node_js:
  - 8

jobs:
  include:
    - stage: STAGE_NAME
      before_script:
        - echo "script 1"
        - echo "script 2"
      script:
        - echo "script 3"
        - echo "script 4"
      after_success:
        - echo "script 3"
        - echo "script 4"

      # after_success 执行完才会执行deploy
      deploy: # 支持多个deploy
        - provider: script # 自由脚本provider
          skip_cleanup: true # 保存上面执行过的内容，比如build后的
          script: bash YOUR_SCRIPT.sh # 注意这里的script由于dpl只接受一个字符串，不能像stage的script，否则过不去，坑
          on:
            branch: master  # 只有branch为master的提交才执行这个deploy

        - provider: npm # 内置的provider
          api_key: $NPM_API_KEY
          skip_cleanup: true # 保存上面执行过的内容，比如build后的
          on:
            tags: true  # 只有tag的提交才执行这个deploy

[whatwewant]

什么是stage

• 官方解释
• 实践理解: CI可以有多个stage，stage不同，则串行执行; stage 相同，则并行

jobs:
  - stage: test
     script: echo "script"
   - stage: build
     script: echo "build"
   - stage: deploy
     script: echo "deploy"
   - stage: build
     script: echo "build parallel"

// 执行顺序 test > build = build > deploy，也就是说test 先执行完毕，然后执行build，最后执行deploy，但是两个build是并行执行的

[whatwewant]

什么是 deploy

• 官方解释
• 实践理解:
  • deploy是很棒的功能，它是在Stage中script或者after_success执行完成之后的发布行为，可用于gh_pages、npm publish、heroku等很多行为，或者script自定义行为，可由provider
  • 和stage一样，deploy也支持多个并行执行

jobs:
  include:
    - stage: deploy
      script:
        - echo "build for deploy"
        - npm run build
      deploy:
        # deploy to gh-pages
        - provider: script
          skip_cleanup: true
          script: bash deploy.sh
          on:
            tags: true
        # deploy to npm === npm publish
        - provider: npm
          skip_cleanup: true
          api_key: $NPM_API_KEY
          on:
            tags: true

• file: deploy.sh

#!/bin/bash
echo "deploy to gh-pages."

rm -rf gh-pages/*
cp -rf dist/* gh-pages
cp CNAME gh-pages
cd gh-pages
git add --all .
git commit -a -m ":sparkles:(TravisCI) automatically update from travis_ci (version: $TRAVIS_TAG)"
git push --quiet "https://${GITHUB_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git" gh-pages:gh-pages

[whatwewant]

script坑 (in stage vs in deploy)

• 1 生命周期:
  • Stage: before_script => script => after_success/after_failure => after_script
  • Deploy: script
• 2 multiple scripts 支持
  • Stage: 支持多个串行script
  • Deploy: 只支持单个script

jobs:
  include:
    - stage: deploy
      before_script:
        - echo "before script"
      script:
        - echo "build for deploy"
        - npm run build
      after_success:
        - echo "after script success"
      deploy:
        # deploy to gh-pages
        - provider: script
          skip_cleanup: true
          script: bash script/deploy.sh
          on:
            tags: true

[whatwewant]

深入理解生命周期(LifeCycle)

• 1 apt addons(可选): 用于更新linux apt source，可自定义sources;
• 2 cache components(可选): 用于缓存组件(yarn)、文件夹(node_modules)等;
• 3 before_install: 用于安装外部依赖包(dependencies)，比如ubuntu packages或者自定义服务;
• 4 install: 执行依赖安装(install any dependencies required)，比如npm install 或者 ./install-dependencies.sh;
• 5 before_script
• 6 script: 执行构建脚本(run the build script);
• 7 before_cache(可选): 用于清空缓存;
• 8 after_success 或者 after_failure: 当script运行完后，after_success可用于构建文档或者部署服务等, after_faiilure可用于上传日志等;
• 9 before_deploy(可选)
• 10 deploy(可选): after_success运行结束后，执行部署服务，比如构建文档、构建gh_pages、发布npm包、部署heroku等;
• 11 after_deploy(可选)
• 12 after_script

[whatwewant]

CI初学者的基础与关键

[whatwewant]

Tips

• 1 cache
• 2 skip_cleanup
• 3 tags

# 1 cache应用 - 缓存node_modules
# 2 skip_cleanup应用 - 保持之前脚本执行环境，默认为false; 当skip_cleanup为false时，Travis CI会清空之前脚本执行结果
# 3 tags应用 - 当on中tags为true时，只允许git tag版本执行部署(deploy)
cache:
  directories:
    - "node_modules"
script: npm test
before_deploy: npm install now --no-save
deploy:
  - provider: script
    script: now --token $NOW_TOKEN && now alias --token $NOW_TOKEN
    skip_cleanup: true
    on:
      tags: true 

[whatwewant]

CI 部署

• 部署说明
• 部署案例
  • gh_pages
  • npm publish
  • now deploy
  • heroku
  • s3 - Rocket.Chat