Release Plan

This article primarily explains how to use Zadig's release plan feature, including planning, approval, and execution of release plans, as well as tracking detailed operation records.

# Planning

Access Management -> Release Plan: Create a new release plan, fill in the details, and save it as a draft. This feature supports multi-person collaboration for planning the release.

Parameter Description:

• Name: The name of the release plan
• Release Owner: The person responsible for this release. After the release plan is formulated, only the owner can execute the release
• Release Window: The time window during which publishing operations can be performed
• Scheduled Execution: Execute the workflow in the release items at a specified time
• Requirement Association: The associated requirement list, supporting multiple JIRA sprints
• Release Content: Specific release content, which can include multiple items. Each release item can specify an owner, and only the specified owner can execute it. Release items include two types: rich text and workflow
  • Rich Text Type: Input content
  • Workflow Type: Select the project and workflow in Zadig and configure the workflow parameters as needed
• Approval Configuration: Configure approval as needed, supporting three methods: Zadig, Feishu, and DingTalk
  • Zadig : The approval application will be sent to the email address corresponding to the account Zadig For specific approval configuration, please refer to the document Zadig
  • Feishu : The approval application will be sent to Feishu. For specific approval configuration, please refer to the document Feishu for approval.
  • Dingtalk : The approval application will be sent to DingTalk. For specific approval configuration, please refer to the document DingTalk approval.

# Approval

This applies to scenarios where the release plan includes approval configuration.

After the release owner submits the approval, the approver is responsible for the approval. Only after the approval is granted can the release owner proceed with the release.

# Execution

For rich text type release content, click Complete on the right and enter the release notes.

For workflow type release content, click Execute on the right to automatically trigger the workflow execution. Click the link to view the workflow execution details.

For release items that need to be skipped, click Skip. Once all release items are either executed or skipped, the release plan will be automatically marked as completed.

# Operation Record

The system keeps a detailed record of the release plan's operation logs. Click Operation Record to view them.

# Hook External Systems and CallBack

# Hook External Systems

Request

POST

Body Parameter Description

Release Plan Status Description

HookReleasePlanJob Parameter Description

Release Plan Task Status Description

TextReleasePlanJob Parameter Description

WorkflowReleasePlanJob Parameter Description

Workflow Parameter Description

WorkflowParam Global Variable Parameter Description

Repo Parameter Description

WorkflowStage Parameter Description

WorkflowJob Parameter Description

WorkflowJobType Parameter Description

WorkflowBuildJobSpec Parameter Description

ServiceAndBuild Parameter Description

KeyVal Parameter Description

WorkflowDeployJobSpec Parameter Description

DeployServiceInfo Parameter Description

DeployModuleInfo Parameter Description

DeployVariableKv Parameter Description

WorkflowVmDeployJobSpec Parameter Description

ServiceAndVmDeploy Parameter Description

WorkflowFreestyleJobSpec Parameter Description

FreeStyleServiceInfo Parameter Description

WorkflowTestingJobSpec Parameter Description

ServiceAndTest Parameter Description

TestModule Parameter Description

WorkflowScanningsJobSpec Parameter Description

ServiceAndScannings Parameter Description

ScanningsModule Parameter Description

WorkflowNacosJobSpec Parameter Description

NacosData Parameter Description

WorkflowApolloJobSpec Parameter Description

ApolloNamespace Parameter Description

ApolloKV Parameter Description

WorkflowSqlJobSpec Parameter Description

WorkflowDistributeImageJobSpec Parameter Description

DistributeImageTarget Parameter Description

Body Parameter Example

{
  "object_kind": "release_plan",
  "event": "release_plan",
  "workflow": null,
  "release_plan": {
    "id": "68b7ec363306e52e21b2dbe6",
    "index": 52,
    "name": "workflow-plan-3",
    "event_name": "all_job_done",
    "manager": "patrick",
    "manager_id": "14790d50-37b3-11f0-b3aa-ee39782dea6e",
    "start_time": 1756883513,
    "end_time": 1757488313,
    "schedule_execute_time": 1756893020,
    "description": "<p><br></p>",
    "created_by": "patrick",
    "create_time": 1756884022,
    "updated_by": "系统",
    "update_time": 1756893023,
    "jobs": [
      {
        "id": "e092f96c-4f78-410e-88bb-7afa881471d9",
        "name": "all",
        "type": "workflow",
        "spec": {
          "workflow": {
            "name": "release-plan-hook-2",
            "display_name": "release-plan-hook-2",
            "disabled": false,
            "category": "",
            "params": [],
            "stages": [
              {
                "name": "build",
                "jobs": [
                  {
                    "name": "build",
                    "type": "zadig-build",
                    "spec": {
                      "source": "runtime",
                      "job_name": "",
                      "ref_repos": false,
                      "service_and_builds": [
                        {
                          "service_name": "service1",
                          "service_module": "service1",
                          "build_name": "yaml-general-build",
                          "image": "{{.job.build.service1.service1.output.IMAGE}}",
                          "package": "{{.job.build.service1.service1.output.PKG_FILE}}",
                          "image_name": "service1",
                          "key_vals": [
                            {
                              "key": "gggg",
                              "value": "gggg",
                              "type": "string",
                              "registry_id": "",
                              "is_credential": false,
                              "description": "",
                              "source": "runtime"
                            }
                          ],
                          "repos": [
                            {
                              "source": "gitlab",
                              "repo_owner": "kr-test-org1",
                              "repo_namespace": "kr-test-org1",
                              "repo_name": "multi-service-demo",
                              "remote_name": "origin",
                              "branch": "patrick-01",
                              "tag": "",
                              "commit_id": "311fa899187a674a2e7fbf76cf2eeecdc8a51ac1",
                              "commit_message": "update service2 values\n",
                              "checkout_path": "",
                              "submodules": false,
                              "codehost_id": 1,
                              "address": "https://gitlab.com/",
                            }
                          ]
                        }
                      ]
                    },
                    "run_policy": ""
                  }
                ]
              }
            ],
            "project": "yaml",
            "description": "",
            "created_by": "patrick",
            "create_time": 1756883358,
            "updated_by": "patrick",
            "update_time": 1756883481,
            "remark": "",
            "enable_approval_ticket": false,
            "approval_ticket_id": ""
          },
          "status": "prepare",
          "task_id": 3
        },
        "status": "failed",
        "executed_by": "系统",
        "executed_time": 1756893022
      }
    ],
    "status": "wait_for_success_external_check",
    "planning_time": 1756892886,
    "approval_time": 0,
    "executing_time": 1756892896,
    "success_time": 1756893100
  }
}

# Release Plan CallBack

Request

POST /api/callback/release_plan

Body Parameter Description

Body Parameter Example

{
    "hook_event": "all_job_done",
    "release_plan_id": "68b7ec363306e52e21b2dbe6",
    "instance_code": "e52e21b68b7ec3",
    "result": "success",
    "failed_reason": ""
}

Normal Response

{
  "id": "6895627bd3a843cb7423728a"
}