docker 发布应用时添加 git revision

baqiao

概要
7 o4 s% v3 ^  j- ^, }( _# H实施步骤
# X  S" d3 X; L6 Z2 c

• 获取 git revision
• 前端 git revision 注入
• 后端 git revision 注入
  : l% ~0 z& x6 k* u1 a0 X+ Z+ v2 G

4 }3 I. U9 W  ^4 W概要
( p/ [7 F  r, \/ Q. O, g& Y3 r. Ddocker 发布应用时, 将 git revision 注入到应用中, 在问题出现时, 可以迅速定位代码版本.

实施步骤

• 获取 git revision
• 将 git revision 传入具体的应用中
  4 R7 s% J- T+ n. K3 z# Q7 L% b; I

       前端的 revision 通过 yarn build 传入
/ s# ~* p2 `/ [7 m% d/ Q       后端的 revision 通过 环境变量传入

, c6 |6 v: z7 k. ~0 M: }1 R; O! z+ c获取 git revision
3 w5 W# A$ n$ L# V3 r6 ^% r

• 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
  

& E  Y2 H' P  J! C% r上面的代码是获取最新的 git revision 的前 8 位, 如果最新的 git revision 有 tag, 则使用 tag 获取的 git revision 放在 GIT_COMMIT 中.
! F6 k' e" H2 Q  D1 d9 W
前端 git revision 注入
: W% H9 K! M! ?首先是 docker build 命令中传入 git revision
# t2 H' n# ~5 I+ u
docker build -t xxx.latest --build-arg VERSION=${GIT_COMMIT} .

然后在 docker file 中获取 VERSION, 并将其传给 yarn build 命令

- Q2 _' F4 w# x/ ^* JARG VERSION=no-version          # 默认值 no-version
* i$ ~0 Q* J) m: J4 dRUN yarn
; M+ b* R( u: R- cRUN yarn build --VERSION=${VERSION}
' x9 V9 U; p* A" ]+ m$ f5 x1 ^' J5 F
4 m& X" H' y# e/ P8 L最后是前端工程中获取此变量, 并在页面的 footer 处显示 git revision
# P5 w9 T. _& n
4 x" K. U# y1 g# {     process.argv
3 n; f! U- M/ i       .filter(str => /^--/.test(str))
       .map(str => str.replace('--', ''))
0 J. W0 `1 o' C) S8 E: {       .forEach(str => {
7 \6 Y* S7 f/ A, u" x3 [7 M# m( b         let sub = str.match(/([\s\S]*)\=([\s\S]*)/)
1 A- S% p  E( |' Y. P( W
( D8 Y$ g6 T9 h4 H         sub ? (TYPE[sub[1]] = sub[2]) : (TYPE[str] = true)
       })
- O5 {7 f- i5 J' S4 W5 J( z2 k
const mergeWebpackConfig = () => (config, env) => {
  // ...省略...

  config.plugins = (config.plugins || []).concat([
+ w. @% H) ~; h4 L    new webpack.DefinePlugin({
7 I5 N5 Y, X2 E( @$ h% M      'process.env.VERSION': JSON.stringify(TYPE['VERSION'])
) l( @2 j, x" g7 c7 f    })
  ])
  // ...省略...
}
<Footer>
  <div
- b3 m+ `2 l* S9 [5 W7 B, r' h$ _    style={{ textAlign: 'center' }}
1 p/ X" A3 x2 C2 t$ q) N    className="gx-layout-footer-content"
  >
* W7 C7 g4 E/ p: L# O    Copyright © 2019 {process.env.VERSION}
  </div>
</Footer>
5 d) u4 }) U/ ~) e6 f) S

% T8 \  G+ _+ @) a后端 git revision 注入
$ {! k" k5 j! v0 _2 I
9 f: s; w) w3 A: _本文的例子是基于 golang 的 API 后端, 获取 git revision 的方法和上面类似.
. l; c0 h: P) z3 L6 F
6 V; D* L" y. [. ^0 B获取 git revision 之后, 在 docker file 中获取 VERSION, 并设置环境变量 VERSION
  k- c/ U2 c0 D8 E8 H2 v1 y4 \
8 Q9 f! j% D* ?) d1 F7 F' d' o( a6 bARG VERSION=no-version
$ W# I- ]  Q- O6 hENV VERSION=${VERSION}

' c" [0 `, z$ f- B* xAPI 服务添加 -v 参数, 用来显示服务的版本

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

if *ver {
; ^; l! T" r3 R+ B9 G/ R( b2 |        fmt.Println(os.Getenv("VERSION"))
        return
}

. X* G, O( f" }5 p& x& q# L% x+ j
3 V+ D1 r8 D  T  Z

NingW

docker 发布应用时添加 git revision