docker 发布应用时添加 git revision

baqiao

概要
2 W" _6 a8 K& h7 f: e' M. l实施步骤

• 获取 git revision
• 前端 git revision 注入
• 后端 git revision 注入
  $ G/ Q# p/ n  }/ F( C9 e- O9 Z

$ I5 K- [' F8 z1 |概要
8 {+ A7 a' ]* g6 l5 g2 G' cdocker 发布应用时, 将 git revision 注入到应用中, 在问题出现时, 可以迅速定位代码版本.

( y$ |' Y. u3 V4 P8 D' f实施步骤

• 获取 git revision
• 将 git revision 传入具体的应用中
  

       前端的 revision 通过 yarn build 传入
' ?7 j+ [& c* Y5 I9 T- q& Y       后端的 revision 通过 环境变量传入

获取 git revision

• GIT_TAG=`git describe --tags`
• IFS='-' read -r -a tags <<< $GIT_TAG
• if [ "${#tags[@]}" = "1" ]; then
•     GIT_COMMIT=$tags
• else
•     GIT_COMMIT=`git rev-parse HEAD | cut -c 1-8`
• fi
  

上面的代码是获取最新的 git revision 的前 8 位, 如果最新的 git revision 有 tag, 则使用 tag 获取的 git revision 放在 GIT_COMMIT 中.
! T5 |2 U( n( I7 |
6 |) ^% s6 o) W/ u前端 git revision 注入
首先是 docker build 命令中传入 git revision
0 L' f7 C( \; |& }9 W4 b+ E
docker build -t xxx.latest --build-arg VERSION=${GIT_COMMIT} .

* p" B( a6 s" t& K% Q然后在 docker file 中获取 VERSION, 并将其传给 yarn build 命令

0 [- c% L/ e: [0 ?3 ?ARG VERSION=no-version          # 默认值 no-version
, y9 |* T; j; j& [4 D1 v0 @( SRUN yarn
, E# [) Y: W" }6 @4 K1 qRUN yarn build --VERSION=${VERSION}

最后是前端工程中获取此变量, 并在页面的 footer 处显示 git revision
' `* }! \% [" d5 q! ]  r: q6 ]$ j
     process.argv
       .filter(str => /^--/.test(str))
' x$ e( r9 I$ G' M! @4 |* v       .map(str => str.replace('--', ''))
2 o5 e% a% a+ j' g       .forEach(str => {
7 u9 @1 V! L( f! j. z* E         let sub = str.match(/([\s\S]*)\=([\s\S]*)/)
7 f( }- G9 L5 P7 I" n
         sub ? (TYPE[sub[1]] = sub[2]) : (TYPE[str] = true)
       })
, B+ _, U5 u* E& U; M
const mergeWebpackConfig = () => (config, env) => {
  // ...省略...
: F- L# Y- T7 A% t2 }6 e  j8 J" I
  config.plugins = (config.plugins || []).concat([
    new webpack.DefinePlugin({
      'process.env.VERSION': JSON.stringify(TYPE['VERSION'])
    })
  ])
: t0 Z) r  o2 {& O  // ...省略...
}
<Footer>
  <div
9 }; V2 X2 [3 W9 e9 h    style={{ textAlign: 'center' }}
    className="gx-layout-footer-content"
  >
' a5 E" N/ L' E, L- [# F4 d% p2 m) Q    Copyright © 2019 {process.env.VERSION}
  </div>
( A' z9 k' ]- x- Z2 `</Footer>


7 z6 U8 K" B1 l后端 git revision 注入

* b+ F9 W2 a( D5 T% b0 T6 Y: S本文的例子是基于 golang 的 API 后端, 获取 git revision 的方法和上面类似.
" V, h$ Y9 \* j) T
获取 git revision 之后, 在 docker file 中获取 VERSION, 并设置环境变量 VERSION
! U4 j# {+ E$ ~9 ~1 i) G$ p; f: r
ARG VERSION=no-version
3 s: l9 j6 H) A8 z6 Q! E- j2 Y- ?ENV VERSION=${VERSION}

! Q$ Q9 i$ S/ d( kAPI 服务添加 -v 参数, 用来显示服务的版本

ver := flag.Bool("v", false, "verify version")
flag.Parse()

if *ver {
        fmt.Println(os.Getenv("VERSION"))
& U4 ^9 k+ I6 \1 ]        return
" k* x- b& e& `& w  @' `: Z}

. \( l" O% w$ i% i5 d4 a" \% |
3 {3 G, v& I# h& Q

NingW

docker 发布应用时添加 git revision