GitLab CI配置Slack自定义通知报invalid payload如何修复

错误根因 #

Slack返回invalid payload的核心原因是生成的请求内容不符合Slack webhook的格式要求，具体问题如下：

• JSON结构破损：Commit Message字段块缺失闭合的}，直接拼接后续的Commit URL字段，导致JSON语法完全失效，Slack无法解析
• 手动拼接JSON无转义：所有变量内容（比如提交信息、用户名）如果包含双引号、换行、反斜杠等特殊字符，会直接破坏JSON结构
• 变量引用错误：脚本中GITLAB_REPO_URL未用${}包裹，不会被Bash解析为变量，会直接作为纯字符串输出；自行执行git rev-parse HEAD取commit hash的逻辑在CI浅克隆场景下大概率取值失败
• 参数传递方式错误：使用--data-urlencode传payload参数是Slack旧版webhook的兼容写法，未指定Content-Type: application/json请求头时，很容易因为转义问题导致格式错误
• 逻辑遗漏：部署失败场景下未给slack_channel赋值，会触发参数缺失错误
• envsubst使用不当：未指定要替换的变量列表时，会替换脚本中所有符合环境变量格式的内容，极易破坏脚本和JSON结构

修复方案 #

核心修复思路是放弃手动拼接JSON，使用jq工具自动生成合法JSON，从根源避免转义和语法错误，同时修正传参和脚本逻辑。

1. 修复Slack通知脚本 #

替换原有slackscript.sh内容为以下版本：

#!/bin/bash
set -euo pipefail

FAILURE=1
SUCCESS=0
# 建议将Webhook地址配置在GitLab CI/CD私密变量中，不要硬编码在脚本里
SLACKWEBHOOKURL="${SLACK_WEBHOOK_URL:-"替换为你的实际webhook地址"}"
SLACK_CHANNEL="替换为你的目标频道名"

function print_slack_summary_deploy() {
    local slack_msg_header
    # 匹配部署状态生成通知头
    if [[ "${EXIT_STATUS}" == "${SUCCESS}" ]]; then
        slack_msg_header=":heavy_check_mark: *Deploy to ${ENVIRONMENT_NAME} succeeded*"
    else
        slack_msg_header=":x: *Deploy to ${ENVIRONMENT_NAME} failed*"
    fi

    # 调用jq生成标准合法JSON，自动完成所有特殊字符转义
    jq -n \
        --arg channel "$SLACK_CHANNEL" \
        --arg header "$slack_msg_header" \
        --arg gitlab_user "$GITLAB_USER_NAME" \
        --arg job_id "$CI_JOB_ID" \
        --arg project_url "$CI_PROJECT_URL" \
        --arg commit_msg "$CI_COMMIT_MESSAGE" \
        --arg commit_sha "$CI_COMMIT_SHA" \
        --arg commit_ref "$CI_COMMIT_REF_NAME" \
        '{
            "channel": $channel,
            "blocks": [
                {
                    "type": "section",
                    "text": {
                        "type": "mrkdwn",
                        "text": $header
                    }
                },
                {"type": "divider"},
                {
                    "type": "section",
                    "fields": [
                        {"type": "mrkdwn", "text": "*Stage:*\nDeploy"},
                        {"type": "mrkdwn", "text": "*Pushed By:*\n\($gitlab_user)"},
                        {"type": "mrkdwn", "text": "*Job URL:*\n\($project_url)/-/jobs/\($job_id)"},
                        {"type": "mrkdwn", "text": "*Commit Message:*\n\($commit_msg)"},
                        {"type": "mrkdwn", "text": "*Commit URL:*\n\($project_url)/-/commit/\($commit_sha)"},
                        {"type": "mrkdwn", "text": "*Commit Branch:*\n\($commit_ref)"}
                    ]
                },
                {"type": "divider"}
            ]
        }'
}

function share_slack_update_deploy() {
    local slack_payload
    slack_payload=$(print_slack_summary_deploy)
    # 以标准JSON格式发送请求，添加正确的请求头
    curl -X POST \
        -H "Content-Type: application/json" \
        -d "$slack_payload" \
        "$SLACKWEBHOOKURL"
}

2. 修复.gitlab-ci.yml配置 #

替换原有after_script相关配置为以下内容：

deploy_staging:
  ENVIRONMENT_NAME: "staging"
  extends: .Deploy_image
  only:
    - master
  # 如果你的部署基础镜像已经预装jq，可以删除下面的before_script配置
  before_script:
    - apt-get update && apt-get install -y --no-install-recommends jq
  after_script:
    # 给CI_JOB_STATUS加默认值，避免变量不存在时脚本报错
    - EXIT_STATUS=${CI_JOB_STATUS:-"failed"}
    - if [ "$EXIT_STATUS" = "success" ]; then EXIT_STATUS=0; else EXIT_STATUS=1; fi
    # 显式指定要替换的变量，避免envsubst误修改脚本其他内容
    - envsubst '${ENVIRONMENT_NAME} ${EXIT_STATUS}' < /tmp/${CI_PIPELINE_ID}/${SCRIPT_PATH}/slackscript.sh > slackscript.sh
    - chmod +x ./slackscript.sh
    - source ./slackscript.sh && share_slack_update_deploy

修复说明 #

• 所有JSON内容由jq生成，自动处理引号、换行、特殊字符的转义，不会出现语法错误
• 直接使用GitLab CI内置的CI_PROJECT_URL、CI_COMMIT_SHA变量拼接链接，不需要自行执行git命令，避免浅克隆导致的取值错误
• 补全了失败场景下的频道参数，不会出现参数缺失
• 修正了curl请求格式，完全符合Slack webhook的接口要求
• 限制envsubst的替换范围，避免破坏脚本原有逻辑

内容的提问来源于stack exchange，提问作者Vlad Tkachuk