AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

通过Git WebHooks+脚本实现自动更新发布代码之shell脚本

2017-11-07 961
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：

前文讲述了《通过Git WebHooks+脚本实现自动更新发布代码》，里面提供了一种自动更新发布代码的脚本编写思路。本文的脚本与前文中的思路（前文思路的实现请参考《通过Git WebHooks+脚本实现自动更新发布代码之Shell脚本（二）》）不太不同。本脚本以capistrano中的一些思想和理念为依据，用简单好理解的shell脚本实现capistrano原本实现的自动化部署部分。

脚本的一些特点和功能：

  1. 解决脚本的符号链接问题，准确获取脚本工作目录（从tomcat脚本中学到）；

  2. 颜色显示，不同级别的信息用不同的颜色显示（共两种方案，前一种从一位不知名的国外工程师处得到，后一种从lnmp1.2脚本中得到）；

  3. 生成capistrano目录结构；

  4. 清除过期目录和文件；

  5. 检查部署要求是否满足，如磁盘空间的需求等，其他的要求检查有待于添加；

  6. 部署失败后归滚；

  7. 项目废弃后删除项目；

  8. 脚本里面尽可能的考虑容错（异常判断）和部分细节；

脚本存在的已知的问题：

（1）脚本中有几个TODO，有待于改善；

（2）repository目录暂时没有用到；

（3）获取git的版本号问题；

（4）部署后生成的日志有待于优化；

（5）脚本基本使用英文（Chinglish）作为注释，部分注释可能不全；

（6）可能存在的其他问题；

为了后期的改进和部分需求变更，也为了便于获取该脚本，此脚本可以从github上获取，欢迎和接受提交任何bug、issue以及任何improvement。

github地址是：

https://github.com/DingGuodong/BashShellHeader/blob/master/example-deploy.sh

脚本内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
#!/bin/bash
 
# Public header
# =============================================================================================================================
# resolve links - $0 may be a symbolic link
PRG= "$0"
 
while  [ -h  "$PRG"  ];  do
   ls =` ls  -ld  "$PRG" `
   link=` expr  "$ls"  :  '.*-> \(.*\)$' `
   if  expr  "$link"  :  '/.*'  >  /dev/null ;  then
     PRG= "$link"
   else
     PRG=` dirname  "$PRG" `/ "$link"
   fi
done
 
# Get standard environment variables
PRGDIR=` dirname  "$PRG" `
 
 
# echo color function
function  cecho {
     # Usage:
     # cecho -red sometext     #Error, Failed
     # cecho -green sometext   # Success
     # cecho -yellow sometext  # Warning
     # cecho -blue sometext    # Debug
     # cecho -white sometext   # info
     # cecho -n                # new line
     # end
 
     while  [  "$1"  ];  do
         case  "$1"  in
             -normal)        color= "\033[00m"  ;;
# -black)         color="\033[30;01m" ;;
-red)           color= "\033[31;01m"  ;;
-green)         color= "\033[32;01m"  ;;
-yellow)        color= "\033[33;01m"  ;;
-blue)          color= "\033[34;01m"  ;;
# -magenta)       color="\033[35;01m" ;;
# -cyan)          color="\033[36;01m" ;;
-white)         color= "\033[37;01m"  ;;
-n)             one_line=1;    shift  ;  continue  ;;
*)               echo  -n  "$1" ;  shift  ;  continue  ;;
esac
 
shift
echo  -en  "$color"
echo  -en  "$1"
echo  -en  "\033[00m"
shift
 
done
if  [ ! $one_line ];  then
         echo
fi
}
# end echo color function
 
# echo color function, smarter
function  echo_r () {
     #Error, Failed
     [ $ # -ne 1 ] && return 0
     echo  -e  "\033[31m$1\033[0m"
}
function  echo_g () {
     # Success
     [ $ # -ne 1 ] && return 0
     echo  -e  "\033[32m$1\033[0m"
}
function  echo_y () {
     # Warning
     [ $ # -ne 1 ] && return 0
     echo  -e  "\033[33m$1\033[0m"
}
function  echo_b () {\
     # Debug
     [ $ # -ne 1 ] && return 0
     echo  -e  "\033[34m$1\033[0m"
}
# end echo color function, smarter
 
WORKDIR=$PRGDIR
# end public header
# =============================================================================================================================
 
# Where to get source code
SOURCEURL=https: //github .com /DingGuodong/GitOSCAutoDeploy .git
 
# Setting how many days do you want save old releases, default is 10 days
save_old_releases_for_days=10
 
function  setDirectoryStructure() {
     if  [ -f $WORKDIR/.lock ]; then
         echo_g  "Set directory structure has been done, skipping. "
         return
     fi
     echo_b  "Setting directory structure."
     # learn from capistrano
     # Refer: http://capistranorb.com/documentation/getting-started/structure/
     # Refer: http://capistranorb.com/documentation/getting-started/structure/#
 
     # ├── current -> /var/www/my_app_name/releases/20150120114500/
     # ├── releases
     # │   ├── 20150080072500
     # │   ├── 20150090083000
     # │   ├── 20150100093500
     # │   ├── 20150110104000
     # │   └── 20150120114500
     # ├── repo
     # │   └── <VCS related data>
     # ├── revisions.log
     # └── shared
     #     └── <linked_files and linked_dirs>
 
     # current is a symlink pointing to the latest release. This symlink is updated at the end of a successful deployment. If the deployment fails in any step the current symlink still points to the old release.
     # releases holds all deployments in a timestamped folder. These folders are the target of the current symlink.
     # repo holds the version control system configured. In case of a git repository the content will be a raw git repository (e.g. objects, refs, etc.).
     # revisions.log is used to log every deploy or rollback. Each entry is timestamped and the executing user (username from local machine) is listed. Depending on your VCS data like branchnames or revision numbers are listed as well.
     # shared contains the linked_files and linked_dirs which are symlinked into each release. This data persists across deployments and releases. It should be used for things like database configuration files and static and persistent user storage handed over from one release to the next.
     # The application is completely contained within the path of :deploy_to. If you plan on deploying multiple applications to the same server, simply choose a different :deploy_to path.
 
     # Check directories for deploy
     # [ ! -d $WORKDIR/current ] && mkdir $WORKDIR/current
     [ ! -d $WORKDIR /release  ] &&  mkdir  $WORKDIR /release
     [ ! -d $WORKDIR /repository  ] &&  mkdir  $WORKDIR /repository
     [ ! -d $WORKDIR /share  ] &&  mkdir  $WORKDIR /share
     # end directories structure
     touch  $WORKDIR/.lock
     echo_g  "Set directory structure successfully! "
}
 
function  checkDependencies() {
     echo_b  "Checking dependencies for deploy procedure. "
     # Refer:
     # if [ -z ${var+x} ]; then
     #     echo "var is unset"; else echo "var is set to '$var'"
     # fi
     # if [ "$var x" = " x" ]; then
     #     echo "var is empty"; else echo "var is set to '$var'"
     # fi
     # if [ -z $var ]; then
     #     echo "var is empty"; else echo "var is set to '$var'"
     # fi
     if  [[ -z $SOURCEURL ]];  then
         echo_r  "Error: SOURCEURL is undefined! "
         exit  1
     fi
     DISKSPACE=` df  $WORKDIR |  tail  -n1 |  awk  '{print $(NF -2)}' `
     if  [[ $DISKSPACE -lt 2097152 ]];  then
         echo_y  "Warning: Disk space of $WORKDIR is smaller than 2GB"
         #exit 1
     fi
 
     echo_g  "All required dependencies check pass! "
 
}
 
function  cleanOldReleases(){
     save_days=${save_old_releases_for_days:-10}
     if  [ ! -d $WORKDIR /release  ];  then
         echo_b  "Can NOT find release directory, skipping . "
         return
     fi
     need_clean=$( find  $WORKDIR /release  -mtime +$save_days - exec  ls  {} \;)
     if  [ ! -z $need_clean ];  then
         echo_g  "Expired releases found and will be removed from project! "
         find  $WORKDIR /release  -mtime +$save_days - exec  rm  -rf {} \;
         if  [ $? - eq  0 ];  then
             echo_g  "Expired releases have removed from project! "
         else
             echo_r  "Can NOT remove expired releases, please alter to Admin users. "
         fi
     else
         echo_g  "All releases are not expired, skipping. "
     fi
 
 
}
function  deploy() {
     # check a directories lock, Note: this is redundant
     if  [[ ! -f $WORKDIR/.lock ]];  then
         setDirectoryStructure
     fi
     cleanOldReleases
     checkDependencies
     # Make directory to release directory
     SOURCEDIR= "$WORKDIR/release/$(date +%Y%m%d%H%M%S)"
     [ ! -d $SOURCEDIR ] &&  mkdir  $SOURCEDIR
 
     # Get files from source code repository
     git clone $SOURCEURL $SOURCEDIR
     # svn co http://$SOURCEURL $WORKDIR/repository
 
     # TODO
     # get branchnames or revision numbers from VCS data
 
 
     # Remove .git or .svn
     [ -d $SOURCEDIR/.git ] &&  rm  -rf $SOURCEDIR/.git
     [ -d $SOURCEDIR/.svn ] &&  rm  -rf $SOURCEDIR/.svn
 
     # ifdef Complie
     # endif
 
     # Make source code symbolic link to current
     ( [ -f $WORKDIR /current  ] || [ -d $WORKDIR /current  ] ) &&  rm  -rf $WORKDIR /current
     ln  -s $SOURCEDIR $WORKDIR /current
 
     # Move conf and logs directies from release to share
     [ -d $WORKDIR /release/conf  ] &&  mv  $WORKDIR /release/conf  $WORKDIR /share/conf
     [ -d $WORKDIR /release/logs  ] &&  mv  $WORKDIR /release/logs  $WORKDIR /share/logs
 
     # Make conf and logs symbolic link to current
     [ -d $WORKDIR /share/conf  ] &&  ln  -s $WORKDIR /share/conf  $WORKDIR /current/conf
     [ -d $WORKDIR /share/logs  ] &&  ln  -s $WORKDIR /share/logs  $WORKDIR /current/logs
 
     # Start service or validate status
     if  [[ -e $WORKDIR /current/bin/startup .sh ]];  then
         $WORKDIR /current/bin/startup .sh start
         RETVAL=$?
     else
         # TODO
         # external health check
         RETVAL=0
     fi
     RETVAL=$?
 
     # if started ok, then create a workable program to a file
     if  [[ $RETVAL - eq  0 ]];  then
     # Note cat with eof must start at row 0, and with eof end only, such as no blank spaces, etc
     cat  >$WORKDIR /share/workable_program .log <<eof
$SOURCEDIR
eof
     echo_g  "Deploy successfully! "
     echo_g  "current workable version is $(cat $WORKDIR/share/workable_program.log)"
     ls  --color=auto -l $WORKDIR /current
     else
         echo_r  "Error: Deploy failed! "
         $0 rollback
     fi
}
 
# Rollback to last right configuraton
function  rollback() {
     # The key is find last files which can work
     WORKABLE_PROGRAM=` cat  $WORKDIR /share/workable_program .log`
     if  [[ -z WORKABLE_PROGRAM ]];  then
         echo_r  "Error: Can NOT find workable release version! Please check if it is first deployment! "
         exit  1
     fi
     # # Stop service
     if  [[ -e $WORKDIR /current/bin/startup .sh ]];  then
         $WORKDIR /current/bin/startup .sh stop
     fi
 
     # Remove failed deploy
     rm  -rf $WORKDIR /current
 
     # Remake source code symbolic link to current
     ln  -s $WORKABLE_PROGRAM $WORKDIR /current
 
     # Remake conf and logs symbolic link to current
     [ -d $WORKDIR /share/conf  ] &&  ln  -s $WORKDIR /share/conf  $WORKDIR /current
     [ -d $WORKDIR /share/logs  ] &&  ln  -s $WORKDIR /share/logs  $WORKDIR /current
 
     # Start service or validate status
     if  [[ -e $WORKDIR /current/bin/startup .sh ]];  then
         $WORKDIR /current/bin/startup .sh start
         RETVAL=$?
     else
         # TODO
         # external health check
         RETVAL=0
     fi
     RETVAL=$?
 
     # if started ok, then create a workable program to a file
     if  [[ $RETVAL - eq  0 ]];  then
         echo_g  "Rollback successfully! "
         echo_g  "current workable version is $WORKABLE_PROGRAM"
         ls  --color=auto -l $WORKDIR /current
     fi
}
 
function  destroy() {
     # echo a warning message
     echo_y  "Warning: This action will destroy all this project, and this is unrecoverable! "
     answer= "n"
     echo_y  "Do you want to destroy this project? "
     read  -p  "(Default no,if you want please input: y ,if not please press the enter button):"  answer
     case  "$answer"  in
         y|Y|Yes|YES| yes |yES|yEs|YeS|yeS )
         # delete all file expect for this script self
         # find: warning: Unix filenames usually don't contain slashes (though pathnames do).  That means that '-name `./deploy.sh'' will probably evaluate to false all the time on this system.  You might find the '-wholename' test more useful, or perhaps '-samefile'.  Alternatively, if you are using GNU grep, you could use 'find ... -print0 | grep -FzZ `./deploy.sh''.
             # echo $WORKDIR/
             #find -L $WORKDIR -type f ! -name "$(basename $0)" -exec ls --color=auto -al {} \;
             # find -L . -type f ! -name "deploy.sh" -exec ls --color=auto -al {} \;
             # find -L . -type d -exec ls --color=auto -al {} \;
             # find -L ./ -maxdepth 1 ! -name "deploy.sh" ! -wholename "./"
         # ls | grep -v "fielname" |xargs rm -rf
         find  -L $WORKDIR -maxdepth 1 ! -name  "$(basename $0)"  ! -wholename  "$WORKDIR"   - exec  rm  -rf {} \;
         if  [ $? - eq  0 ]; then
             echo_g  "Destory this project successfully! Now will exit with status 0. "
             exit  0
         else
             echo_r  "Error: something go wrong! Please check or alter to Admin user! "
             exit  1
         fi
         ;;
         n|N|No|NO|no|nO)
         echo_g  "destroy action is cancel"
         exit  0
         ;;
         *)
         echo_r  "Are you kidding me? You are a bad kid! "
         exit  1
         ;;
     esac
 
}
 
# Just a test for call itself, comment it
# if [[ $# -lt 1 ]]; then
#  $0 help
#  exit
# fi
case  $1  in
     deploy)
         deploy
         ;;
     rollback)
         rollback
         ;;
     destroy)
         destroy
         ;;
     help|*)
         echo  "Usage: $0 {deploy|rollback|destroy} with $0 itself"
         exit  1
         ;;
esac
 
# This is not essential with 'case .. esac' handled no args excutions
# replace "exit 0" with ":"
#exit 0
:

tag:自动化部署脚本,Shell部署脚本,capistrano的shell脚本实现,脚本实现自动更新和回滚,自动化部署shell脚本实例

--end--



本文转自 urey_pp 51CTO博客，原文链接：http://blog.51cto.com/dgd2010/1735106，如需转载请自行联系原作者



文章标签：
Shell
开发工具
git
持续交付
关键词：
Shell脚本
Shell git
GIT代码
Shell代码
脚本Shell
技术小胖子
目录
相关文章
LKIDTI数据
|
1月前
|
Shell
一个用于添加/删除定时任务的shell脚本
一个用于添加/删除定时任务的shell脚本
LKIDTI数据
86 1
冷冻工厂
|
25天前
|
Shell Linux 测试技术
6种方法打造出色的Shell脚本
6种方法打造出色的Shell脚本
冷冻工厂
48 2
6种方法打造出色的Shell脚本
蓝易云
|
11天前
|
XML JSON 监控
Shell脚本要点和难点以及具体应用和优缺点介绍
Shell脚本在系统管理和自动化任务中扮演着重要角色。尽管存在调试困难、可读性差等问题，但其简洁高效、易于学习和强大的功能使其在许多场景中不可或缺。通过掌握Shell脚本的基本语法、常用命令和函数，并了解其优缺点，开发者可以编写出高效的脚本来完成各种任务，提高工作效率。希望本文能为您在Shell脚本编写和应用中提供有价值的参考和指导。
蓝易云
33 1
eisc
|
16天前
|
Ubuntu Shell 开发工具
ubuntu/debian shell 脚本自动配置 gitea git 仓库
这是一个自动配置 Gitea Git 仓库的 Shell 脚本，支持 Ubuntu 20+ 和 Debian 12+ 系统。脚本会创建必要的目录、下载并安装 Gitea，创建 Gitea 用户和服务，确保 Gitea 在系统启动时自动运行。用户可以选择从官方或小绿叶技术博客下载安装包。
eisc
37 2
eisc
|
30天前
|
监控 网络协议 Shell
ip和ip网段攻击拦截系统-绿叶结界防火墙系统shell脚本
这是一个名为“小绿叶技术博客扫段攻击拦截系统”的Bash脚本，用于监控和拦截TCP攻击。通过抓取网络数据包监控可疑IP，并利用iptables和firewalld防火墙规则对这些IP进行拦截。同时，该系统能够查询数据库中的白名单，确保合法IP不受影响。此外，它还具备日志记录功能，以便于后续分析和审计。
eisc
49 6
我不是游客20240119
|
26天前
|
运维 监控 Shell
深入理解Linux系统下的Shell脚本编程
【10月更文挑战第24天】本文将深入浅出地介绍Linux系统中Shell脚本的基础知识和实用技巧，帮助读者从零开始学习编写Shell脚本。通过本文的学习，你将能够掌握Shell脚本的基本语法、变量使用、流程控制以及函数定义等核心概念，并学会如何将这些知识应用于实际问题解决中。文章还将展示几个实用的Shell脚本例子，以加深对知识点的理解和应用。无论你是运维人员还是软件开发者，这篇文章都将为你提供强大的Linux自动化工具。
我不是游客20240119
45 1
qa浪涛
|
1月前
|
开发工具 git
git如何修改提交代码时的名字和邮箱？
git如何修改提交代码时的名字和邮箱？
qa浪涛
89 4
小王老师呀
|
1月前
|
Java Linux 开发工具
IDEA中git提交前如何关闭code analysis以及开启格式化代码
【10月更文挑战第12天】本文介绍了在 IntelliJ IDEA 中关闭代码分析和开启代码格式化的步骤。关闭代码分析可通过取消默认启用检查或针对特定规则进行调整实现，同时可通过设置 VCS 静默模式在提交时跳过检查。开启代码格式化则需在 `Settings` 中配置 `Code Style` 规则，并通过创建 Git 钩子实现提交前自动格式化。
小王老师呀
323 3
小Lee
|
1月前
|
监控 Unix Shell
shell脚本编程学习
【10月更文挑战第1天】shell脚本编程
小Lee
70 12
mrq4nk6ni2neg
|
1月前
|
存储 运维 监控
自动化运维：使用Shell脚本简化日常任务
【9月更文挑战第35天】在IT运维的日常工作中，重复性的任务往往消耗大量的时间。本文将介绍如何通过编写简单的Shell脚本来自动化这些日常任务，从而提升效率。我们将一起探索Shell脚本的基础语法，并通过实际案例展示如何应用这些知识来创建有用的自动化工具。无论你是新手还是有一定经验的运维人员，这篇文章都会为你提供新的视角和技巧，让你的工作更加轻松。
mrq4nk6ni2neg
60 2