加入 BEFORE_FUNC和AFTER_FUNC 方法

Author: libin

.github/deploy.example.yml renamed to .github/workflows/deploy.example.yml

@@ -4,28 +4,26 @@ on:
   push:
     branches:
       - main
-      - master
+      - feature/before_after_func
+#  pull_request:
+#    branches:
+#      - main
 
 env:
-  # Docker 账户
-  DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+  DOCKER_USERNAME: ${{ env.DOCKER_USERNAME }}
   DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
   DOCKER_REGISTRY_URL: "registry.cn-hangzhou.aliyuncs.com" # 示例：阿里云私有镜像仓库
-  # Docker 镜像地址
-  DOCKER_IMAGE: "registry.cn-hangzhou.aliyuncs.com/example_namespace/example_image"
+  DOCKER_IMAGE: "registry.cn-hangzhou.aliyuncs.com/example-namespace/example-deployments"
   DOCKER_IMAGE_TAG: ""
-  # Docker 容器启动配置
-  CONTAINER_NAME: "example_container"
-  DOCKER_RUN_PARAMS: "-p 91:80 -e APP_ENV=example"
-  # 服务器
-  SERVER_HOST: ${{ secrets.SERVER_HOST }}
-  SERVER_USER: ${{ secrets.SERVER_USER }}
+  CONTAINER_NAME: "example-deployments"
+  DOCKER_RUN_PARAMS: "-p 88:80 -e APP_ENV=example"
+  SERVER_HOST: ${{ env.SERVER_HOST }}
+  SERVER_USER: ${{ env.SERVER_USER }}
   SERVER_SSH_PRIVATE_KEY: ${{ secrets.SERVER_SSH_PRIVATE_KEY }}
 
 jobs:
   CI-Build:
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -41,33 +39,38 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: Run PHP syntax check
-        run: find . -type f -name "*.php" -exec php -l {} \; | tee php-syntax-check.log
-
-      - name: Build Docker image
-        run: |
-          docker build -t ${{ env.DOCKER_IMAGE }} .
-
       - name: Login to Docker Hub
         uses: docker/login-action@v3
         with:
           username: ${{ env.DOCKER_USERNAME }}
           password: ${{ env.DOCKER_PASSWORD }}
           registry: ${{ env.DOCKER_REGISTRY_URL }} # 私有镜像仓库，需要配置此地址
 
-      - name: Push Docker image
-        run: |
-          docker tag ${{ env.DOCKER_IMAGE }} ${{ env.DOCKER_IMAGE }}:latest
-          docker push ${{ env.DOCKER_IMAGE }}:latest
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./tests/Dockerfile
+          push: true
+          tags: ${{ env.DOCKER_IMAGE }}:latest
 
 
   CD-Deploy:
     needs: CI-Build
     runs-on: ubuntu-latest
-
     steps:
       - name: Deploy to server
         run: |
+          export BEFORE_FUNC=$(cat <<'EOF'
+            echo "I am before function"
+          EOF
+          )
+          
+          export AFTER_FUNC=$(cat <<'EOF'
+            echo "I am after function"
+          EOF
+          )
+          
           curl -o deploy.sh https://raw.githubusercontent.com/jefferyjob/deployments/refs/heads/main/scripts/deploy.docker.sh
           chmod +x deploy.sh
           ./deploy.sh key deploy

Makefile

@@ -3,6 +3,12 @@
 test: ## 语法错误检测
 	shellcheck -e SC2046 -e SC2317 scripts/*.sh
 
+.PHONY:docker
+docker: ## 测试Docker容器服务
+	docker build -f tests/Dockerfile -t example-deployments .
+	docker stop example-deployments || true
+	docker rm example-deployments || true
+	docker run -d -p 8080:80 --name example-deployments example-deployments
 
 .PHONY:help
 .DEFAULT_GOAL:=help

README.cn.md

@@ -17,20 +17,30 @@
 ## 使用方法
 
 ### 环境变量配置
-| 变量名                    | 是否必须 | 描述                                                                                |
-|------------------------|-----|-----------------------------------------------------------------------------------|
-| DOCKER_IMAGE           | 是   | Docker 镜像地址，包括镜像名称和标签（如：`example_namespace/myapp`），用于拉取并启动指定的应用容器。                |
-| CONTAINER_NAME         | 是   | Docker 容器名称（如：`my_container`），在 Docker 中唯一标识该容器，确保不与其他容器冲突。                       |
-| SERVER_HOST            | 是   | 远程服务器的主机名或 IP 地址（如：`192.168.1.100`），用于通过 SSH 连接到目标服务器。                            |
-| SERVER_USER            | 是   | 服务器登录用户名（如：`root`），确保该用户具备操作 Docker 的权限。                                          |
-| DOCKER_USERNAME        | 否   | Docker 仓库的登录账号（如：`mydockeruser`），用于从私有镜像仓库中拉取镜像。                                  |
-| DOCKER_PASSWORD        | 否   | Docker 仓库的登录密码（如：`secret_password`），配合 `DOCKER_USERNAME` 使用，用于私有镜像的认证。            |
-| DOCKER_REGISTRY_URL    | 否   | Docker 仓库的 URL 地址（如：`https://index.docker.io/v1`）， 若为空，则默认使用 Docker Hub。          |
-| DOCKER_IMAGE_TAG       | 否   | 要部署的镜像版本标签（如：`latest`），默认为 `latest`，用于指定 Docker 镜像的版本。                            |
-| DOCKER_RUN_PARAMS      | 否   | 启动容器时传递的额外运行参数（如：`-e ENV=prod`），可以包括环境变量、端口映射等。                                   |
-| SERVER_PASSWORD        | 否   | 服务器登录密码（如：`mypassword`），仅在 `AUTH_METHOD` 为 `pwd` 时使用。                             |
+| 变量名                    | 是否必须 | 描述                                             |
+|------------------------|-----|------------------------------------------------|
+| DOCKER_IMAGE           | 是   | Docker 镜像地址，包括镜像名称和标签（如：`example_namespace/myapp`），用于拉取并启动指定的应用容器。 |
+| CONTAINER_NAME         | 是   | Docker 容器名称（如：`my_container`），在 Docker 中唯一标识该容器，确保不与其他容器冲突。 |
+| SERVER_HOST            | 是   | 远程服务器的主机名或 IP 地址（如：`192.168.1.100`），用于通过 SSH 连接到目标服务器。 |
+| SERVER_USER            | 是   | 服务器登录用户名（如：`root`），确保该用户具备操作 Docker 的权限。       |
+| DOCKER_USERNAME        | 否   | Docker 仓库的登录账号（如：`mydockeruser`），用于从私有镜像仓库中拉取镜像。 |
+| DOCKER_PASSWORD        | 否   | Docker 仓库的登录密码（如：`secret_password`），配合 `DOCKER_USERNAME` 使用，用于私有镜像的认证。 |
+| DOCKER_REGISTRY_URL    | 否   | Docker 仓库的 URL 地址（如：`https://index.docker.io/v1`）， 若为空，则默认使用 Docker Hub。 |
+| DOCKER_IMAGE_TAG       | 否   | 要部署的镜像版本标签（如：`latest`），默认为 `latest`，用于指定 Docker 镜像的版本。 |
+| DOCKER_RUN_PARAMS      | 否   | 启动容器时传递的额外运行参数（如：`-e ENV=prod`），可以包括环境变量、端口映射等。 |
+| SERVER_PASSWORD        | 否   | 服务器登录密码（如：`mypassword`），仅在 `AUTH_METHOD` 为 `pwd` 时使用。 |
 | SERVER_SSH_PRIVATE_KEY | 否   | SSH 私钥内容（如：`-----BEGIN PRIVATE KEY-----`），用于密钥登录服务器，仅在 `AUTH_METHOD` 为 `key` 时使用。 |
+| BEFORE_FUNC | 否   | 部署前运行脚本                                        |
+| AFTER_FUNC | 否   | 部署后运行脚本                                        |
 
+`BEFORE_FUNC` 和 `AFTER_FUNC` 示例代码
+
+```bash
+BEFORE_FUNC=$(cat <<'EOF'
+  echo "I am before function"
+EOF
+)
+```
 
 ### 脚本运行
 **方法1: 不下载直接运行部署脚本**

scripts/deploy.docker.sh

@@ -50,6 +50,9 @@ print_env() {
   echo "  CONTAINER_NAME: $CONTAINER_NAME"
   echo "  DOCKER_RUN_PARAMS: $DOCKER_RUN_PARAMS"
   echo "--------------------------------------------------------------------------"
+  [[ -n "$BEFORE_FUNC" ]] && echo "  BEFORE_FUNC: ******"
+  [[ -n "$AFTER_FUNC" ]] && echo "  AFTER_FUNC: ******"
+  echo "--------------------------------------------------------------------------"
   echo "  AUTH_METHOD: $AUTH_METHOD"
   echo "  ACTION: $ACTION"
   echo "--------------------------------------------------------------------------"
@@ -160,11 +163,11 @@ deploy_pwd_server() {
 
 # 远程服务器上执行的部署逻辑
 deploy_server() {
-  # 确保脚本遇到错误时退出
-  set -e
+  set -e # 确保脚本遇到错误时退出
+  sudo -i # 切换到root用户
 
-  # 切换到root用户
-  sudo -i
+  # 部署前运行脚本
+  deploy_before_func
 
   # 备份现有的容器和镜像
   deploy_backup_container
@@ -179,6 +182,9 @@ deploy_server() {
 
   # 如果部署成功，删除备份镜像并清理系统
   deploy_cleanup
+
+  # 部署后运行脚本
+  deploy_after_func
 }
 
 # 读取并导出所需的环境变量
@@ -191,12 +197,15 @@ export_env_vars() {
   export DOCKER_IMAGE_TAG='$DOCKER_IMAGE_TAG'; \
   export CONTAINER_NAME='$CONTAINER_NAME'; \
   export DOCKER_RUN_PARAMS='$DOCKER_RUN_PARAMS'; \
+  export BEFORE_FUNC='$BEFORE_FUNC'; \
+  export AFTER_FUNC='$AFTER_FUNC'; \
   "
 }
 
 # 登陆Docker镜像仓库
 deploy_login_docker() {
   if [[ -z "$DOCKER_REGISTRY_URL" ]]; then
+    echo "未配置 DOCKER_REGISTRY_URL 跳过登陆Docker镜像仓库"
     return
   fi
 
@@ -210,6 +219,7 @@ deploy_login_docker() {
 # 退出登陆Docker镜像仓库
 deploy_logout_docker() {
   if [[ -z "$DOCKER_REGISTRY_URL" ]]; then
+    echo "未配置 DOCKER_REGISTRY_URL 跳过退出登陆Docker镜像仓库"
     return
   fi
 
@@ -293,6 +303,25 @@ deploy_cleanup() {
   sudo docker system prune -f || true
 }
 
+deploy_before_func() {
+  if [[ -z "$BEFORE_FUNC" ]]; then
+    echo "未配置 BEFORE_FUNC 方法，跳过执行"
+    return
+  fi
+
+  echo "准备运行 BEFORE_FUN 方法..."
+  $BEFORE_FUNC
+}
+
+deploy_after_func() {
+  if [[ -z "$AFTER_FUNC" ]]; then
+    echo "未配置 AFTER_FUNC 方法，跳过执行"
+    return
+  fi
+
+  echo "准备运行 AFTER_FUNC 方法..."
+  $AFTER_FUNC
+}
 
 ######################################################################
 # Docker 服务部署

tests/Dockerfile

@@ -0,0 +1,7 @@
+FROM registry.cn-hangzhou.aliyuncs.com/jefferyjob/nginx:latest
+
+WORKDIR /usr/share/nginx/html
+RUN echo '<!DOCTYPE html><html><head><title>Hello Jefferyjob</title></head><body><h1>Hello Jefferyjob/deployments</h1></body></html>' > index.html
+EXPOSE 80
+
+CMD ["nginx", "-g", "daemon off;"]