云效 (Alibaba Cloud Yunxiao)

https://help.aliyun.com/zh/yunxiao/
Admin
云效（Alibaba Cloud Yunxiao）是阿里云提供的一站式 DevOps 平台，涵盖项目协作、代码管理、流水线、测试管理和制品仓库等软件研发全生命周期服务。
Tokens:2,565,899
Snippets:11,705
Trust Score:10
Update:16 hours ago
Show doc for...
Tokens:
Raw
### NPM 和 GoLang 配置 git config 命令

Source: https://help.aliyun.com/zh/yunxiao/user-guide/set-dependent-download-access-credentials

在 npm install 或 go get 之前添加此命令，使用环境变量 GIT_USERNAME 和 GIT_PASSWORD 配置 Git 仓库访问凭证。将 codeup.aliyun.com 替换为实际使用的 Git 仓库域名。

```shell
git config --global url."https://${GIT_USERNAME}:${GIT_PASSWORD}@codeup.aliyun.com".insteadOf "https://codeup.aliyun.com"
```

--------------------------------

### Build and install commands for a new step

Source: https://help.aliyun.com/zh/yunxiao/user-guide/use-flow-cli-to-customize-development-steps

These commands are executed after initialization to install dependencies and build the step. The example shows changing into the step directory, running npm install, and then npm run build. The build produces a dist directory containing dist/index.js, which is the actual file executed by Flow.

```bash
cd HelloV2StepWorld && npm install && npm run build
```

--------------------------------

### Clone RedlineSonar example repository

Source: https://help.aliyun.com/zh/yunxiao/user-guide/scenario-example-developing-sonarqube-scanning-steps-with-redlines

Clones the RedlineSonar example repository from atomgit.com to get the sample code for developing a custom SonarQube scanning step.

```shell
git clone https://atomgit.com/flow-step-custom/RedlineSonar.git
```

--------------------------------

### 更新服务端仓库配置

Source: https://help.aliyun.com/zh/yunxiao/user-guide/capacity-and-cleanup-instructions

在example.git中执行git config命令，关闭mirror配置，以便后续强制推送。

```sh
git config remote.origin.mirror false
```

--------------------------------

### 启动脚本示例

Source: https://help.aliyun.com/zh/yunxiao/user-guide/host-deployment-orchestration

在应用环境部署时，每台主机上执行，用于启动服务。典型逻辑是先解压制品包到指定目录，再执行启动文件（如deploy.sh start）。

```sh
# 一个典型的启动脚本逻辑如下：先将制品包解压缩到指定目录中，再执行启动文件（通常在代码中维护，如示例中的deploy.sh）。
mkdir -p /home/admin/application
tar zxvf /home/admin/app/package.tgz -C /home/admin/application/
sh /home/admin/application/deploy.sh start
```

--------------------------------

### Get Pipeline Details API Response (JSON)

Source: https://help.aliyun.com/zh/yunxiao/developer-reference/getpipeline-get-pipeline-details

Example response from the Get Pipeline Details API. Contains pipeline metadata and the pipelineConfig.flow field with a YAML pipeline definition. The sources array shows a Codeup repository configuration.

```json
{
    "createTime": 1729178040000,
    "creatorAccountId": "112222122",
    "envId": 0,
    "envName": "日常环境",
    "groupId": 1111,
    "modifierAccountId": "112222122",
    "name": "流水线",
    "pipelineConfig": {
        "flow": "schema: tb pipeline:   - name: 执行命令     stages:       - driven: AUTO         jobs:           - displayName: 执行命令             task: execution-component-production@10             identifier: '10_1626147407245'             templateType: task             templateSign: ''             templateBatchUpdate: 'N'             extraInfo: ''             params:               version1: pre-jdk1.62               steps:                 - name: 执行命令                   stepType: exec-shell                   stepIdentifier: '10_1626147407245__11_1626147407249'                   command: |                     # input your command here                     echo hello,world!                   ARTIFACTS: ''                   JSONEncoding: true                   freeInTaskGroupModeFields:                     - ARTIFACTS                   source: 132504-sss_ddd_3mvJ               ENGINE_PIPELINE_NAME: '${INPUTS.ENGINE_PIPELINE_NAME}'               ENGINE_PIPELINE_ID: '${INPUTS.ENGINE_PIPELINE_ID}'               ENGINE_PIPELINE_INST_ID: '${INPUTS.ENGINE_PIPELINE_INST_ID}'               ENGINE_PIPELINE_INST_NUMBER: '${INPUTS.ENGINE_PIPELINE_INST_NUMBER}'               buildNodeGroup: K8S-4             plugins: []             output: []             freeInTaskGroupModeFields: []",
        "settings": "{}",
        "sources": [
            {
                "data": {
                    "branch": "master",
                    "cloneDepth": 1,
                    "credentialId": 222,
                    "credentialLabel": "企业公钥",
                    "credentialType": "region-ssh",
                    "events": [
                        
                    ],
                    "isBranchMode": false,
                    "isCloneDepth": true,
                    "isSubmodule": false,
                    "isTrigger": true,
                    "label": "cdup/ss",
                    "namespace": "asasasas",
                    "repo": "https://codeup.aliyun.com/test.git",
                    "serviceConnectionId": 12,
                    "triggerFilter": ".*",
                    "webhook": "https://flow.aliyun/webhook/asassasa"
                },
                "sign": "xxsxsxs",
                "type": "Codeup"
            }
        ]
    },
    "tagList": [
        {
            "id": 22,
            "name": "标签1"
        }
    ],
    "type": "PIPELINEASCODE",
    "updateTime": 1729178040000
}
```

--------------------------------

### 本地推送Maven包时使用settings.xml执行deploy

Source: https://help.aliyun.com/zh/yunxiao/user-guide/faq-13

在代码根目录下运行此命令，使用指定的settings.xml文件执行Maven的clean deploy操作，并跳过测试。注意：-s参数应指向拥有私有仓库推送权限的账号下载的settings.xml文件路径。

```bash
mvn clean deploy -s settings.xml -U -DskipTests
```

--------------------------------

### Runner 安装日志（Linux Systemd 服务类型）

Source: https://help.aliyun.com/zh/yunxiao/user-guide/pipeline-runner

展示在 Linux 上安装 Runner 时选择 Systemd 服务类型的安装日志，包含 install 和 start 命令及服务状态输出。

```log
[INFO] install runner system service
/usr/local/share/yunxiao-runner/v0.1.1/runner install --tenant=be-xxx
INFO[2024-02-28T11:09:17+08:00] service type linux-systemd
INFO[2024-02-28T11:09:17+08:00] Aliyun yunxiao runner-v0.1.1-be-xxx service, linux-systemd installed
[INFO] start runner service
/usr/local/share/yunxiao-runner/v0.1.1/runner start --tenant=be-xxx
INFO[2024-02-28T11:09:17+08:00] service type linux-systemd
INFO[2024-02-28T11:09:17+08:00] Aliyun yunxiao runner-v0.1.1-be-xxx service started
INFO[2024-02-28T11:09:17+08:00] Aliyun yunxiao runner-v0.1.1-be-xxx service status running
```

--------------------------------

### Maven 本地构建命令（使用自定义 settings.xml 和本地仓库）

Source: https://help.aliyun.com/zh/yunxiao/user-guide/faq-13

在代码根目录运行此命令，使用指定的 settings.xml 文件（-s 参数）和本地仓库目录（-Dmaven.repo.local）进行构建，用于排查本地构建下载不到依赖包的问题。注意 -s 参数后为拥有权限拉取私服包的账号登录云效私服下载的 settings.xml 文件路径。

```bash
mvn clean install -s settings.xml -U -DskipTests -Dmaven.repo.local=/tmp/repo
```

--------------------------------

### 新建步骤命令

Source: https://help.aliyun.com/zh/yunxiao/user-guide/custom-step-flow-cli-subcommand-step

执行 flow step init <your-step-sign> 新建步骤，注意将 <your-step-sign> 更换为自己的步骤标识，标识为整个云效唯一。

```bash
flow step init <your-step-sign>
```

--------------------------------

### Install Git and SVN on Ubuntu

Source: https://help.aliyun.com/zh/yunxiao/user-guide/migrate-svn-repository-to-git

Installs Git and SVN on Ubuntu using apt-get. This is the first step before installing git-svn.

```sh
apt-get install git subversion
```

--------------------------------

### GET /v1/oauth2/authorize

Source: https://help.aliyun.com/zh/yunxiao/developer-reference/oauth-2-0-authorization-support-documentation

授权端点，用于用户登录并确认授权，下发授权码。支持 GET 和 POST 方法，需要用户登录。

```APIDOC
## GET /v1/oauth2/authorize

### Description
授权端点，用于用户登录并确认授权，下发授权码。支持 GET 和 POST 方法，需要用户登录。

### Method
GET

### Endpoint
/v1/oauth2/authorize

### Parameters
#### Query Parameters
- **response_type** (string) - Required - 响应类型，固定为 "code"
- **client_id** (string) - Required - 客户端标识
- **redirect_uri** (string) - Required - 重定向 URI
- **scope** (string) - Optional - 请求的权限范围，仅作元数据存储
- **state** (string) - Optional - 客户端状态值，用于防止 CSRF
- **code_challenge** (string) - Required - PKCE 挑战值
- **code_challenge_method** (string) - Required - PKCE 挑战方法，固定为 "S256"

### Request Example
GET /v1/oauth2/authorize?response_type=code&client_id=example-client-id&redirect_uri=https%3A%2F%2Fclient.example.com%2Fcallback&scope=read&state=xyz&code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM&code_challenge_method=S256

### Response
#### Success Response (302)
- **Location** (string) - 重定向到 redirect_uri，携带 code 和 state 参数

#### Response Example
HTTP/1.1 302 Found
Location: https://client.example.com/callback?code=example-auth-code&state=xyz
```

--------------------------------

### 初始化 Codeup-CLI 配置文件

Source: https://help.aliyun.com/zh/yunxiao/user-guide/migrate-self-built-gitlab-to-region-station

执行 ./codeup-cli init 命令初始化配置文件，成功后输出 config.yaml 路径。

```shell
./codeup-cli init
```

```shell
demo:workspace my$ ./codeup-cli init
【成功】 初始化 config.yaml 成功，路径地址为 /Users/my/config.yaml，请按照帮助文档正确填写配置。
```

--------------------------------

### GET 请求语法 - 中心版

Source: https://help.aliyun.com/zh/yunxiao/developer-reference/listmergerequests-query-the-list-of-merge-requests-old

使用 GET 请求查询合并请求列表，需替换 {domain} 为服务接入点，并携带个人访问令牌。

```bash
GET https://{domain}/oapi/v1/codeup/organizations/{organizationId}/mergeRequests
```

--------------------------------

### Maven 查看有效 settings 配置命令

Source: https://help.aliyun.com/zh/yunxiao/user-guide/faq-13

在本地运行此命令，通过日志查看私库地址是否已经配置到 settings.xml 中，用于验证本地 Maven 配置是否正确。

```bash
mvn help:effective-settings
```

--------------------------------

### Region版请求语法 - GET 获取里程碑列表

Source: https://help.aliyun.com/zh/yunxiao/developer-reference/listmilestones

Region版 API 请求语法，使用 GET 方法，路径中不包含 organizationId。

```bash
GET https://{domain}/oapi/v1/projex/projects/{id}/milestones
```

--------------------------------

### flow-cli step init 初始化模板 step.yaml

Source: https://help.aliyun.com/zh/yunxiao/user-guide/v2-step-yaml-description-language

这是 flow-cli step init 生成的步骤YAML模板，定义了步骤的基本信息、执行配置和参数列表。参数类型包括 input、password、textarea、select、checkbox，并展示了 showCondition 条件显示用法。

```yaml
---
apiVersion: V2
kind: DefaultJob
id: FlowCustomStep
name: 流水线自定义步骤
description: flow custom step demo
helpUrl: https://atomgit.com/flow-step-custom/Test
execution:
  executor: node
  main: dist/index.js
items:
  - label: input 参数
    name: abc
    type: input
    description: input 类型参数 abc
    value: hello world
  - label: password 参数
    name: your_password
    type: password
    description: password 类型参数 your_password
  - label: textarea 参数
    name: exclusion
    type: textarea
    value: |
      test/
      build/
    description: textarea 类型参数 exclusion
  - label: select 参数
    name: select_version
    type: select
    value: v1.0.0
    datasource:
      - label: "v1.0.0"
        value: v1.0.0
      - label: "v1.0.1"
        value: v1.0.1
      - label: "v1.0.2"
        value: v1.0.2
    description: select 类型参数 select_version
  - label: 参数 edf
    name: edf
    type: input
    showCondition: ${select_version} == "v1.0.0"
    description: 配置 showCondition，只有当 select_version == v1.0.0 才展示
  - label: 开关
    name: toggle
    type: checkbox
    value: false
```

--------------------------------

### Response example

Source: https://help.aliyun.com/zh/yunxiao/developer-reference/query-scheduled-task-execution-records

Example JSON response showing the structure of runs and steps.

```json
{
    "runs": [
        {
            "eventId": "",
            "finishedAt": "",
            "ruleVersion": 0,
            "startedAt": "",
            "status": "running",
            "steps": [
                {
                    "actionId": "run_ai",
                    "detail": "",
                    "durationMs": 0,
                    "finishedAt": "",
                    "kind": "ai",
                    "startedAt": "",
                    "status": "running"
                }
            ],
            "trigger": "manual"
        }
    ],
    "truncated": false
}
```

--------------------------------

### curl request example for Region edition

Source: https://help.aliyun.com/zh/yunxiao/developer-reference/listappreleasestageruns

Example curl command for the Region edition, which omits the organizationId path parameter. Includes the same query parameters and x-yunxiao-token header as the Central edition example.

```bash
curl -X 'GET' \
  'https://{domain}/oapi/v1/appstack/apps/my-web-service/releaseWorkflows/3f472a12b15d4f418ad6227bb85f787c/releaseStages/6b4c53eee9a842c6a11235b29d002a81/executions?pagination=keyset&perPage=20&orderBy=id&sort=asc&nextToken=token&page=1' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'
```

--------------------------------

### 构建任务命令：配置NuGet源并拉取依赖

Source: https://help.aliyun.com/zh/yunxiao/use-cases/a-step-by-step-guide-to-net-application-development-with-apsara-devops

在构建任务中，使用此命令配置NuGet仓库凭证、拉取Newtonsoft.Json包并执行构建。注意替换凭证和URL为实际值。

```bash
# 配置 nuget 仓库凭证
dotnet nuget add source http://yunxiao-poc.devops.aliyuncs.com:80/packages/02e873bb-f911-48ac-ad73-ec2298c5385d/nuget/repo-hzaul/index.json -n repo-hzaul -u "xxxxxxxxxxx" -p "xxxxxxxxx"
# 拉取 nuget 依赖包
dotnet add package Newtonsoft.Json  --source http://yunxiao-poc.devops.aliyuncs.com:80/packages/02e873bb-f911-48ac-ad73-ec2298c5385d/nuget/repo-hzaul/index.json
# mubuild 构建
dotnet msbuild  /p:Configuration=Debug /t:Publish
```

--------------------------------

### Install git-filter-repo

Source: https://help.aliyun.com/zh/yunxiao/user-guide/git-filter-repo

Installs git-filter-repo by copying the executable to /usr/local/bin. Requires sudo privileges.

```sh
cd git-filter-repo/
sudo cp git-filter-repo /usr/local/bin
```

--------------------------------

### 配置 NPM 仓库凭证并推送制品

Source: https://help.aliyun.com/zh/yunxiao/user-guide/npm-artifact-management

在 NPM 配置页签下选择推送，先设置仓库凭证：执行 npm config set registry=<仓库地址> 指定 registry，再执行 npm login 并输入账号和密码完成登录，最后执行 npm publish 推送制品。

```bash
npm config set registry=<仓库地址>
```

```bash
npm login
```

```bash
npm publish
```
Tokens:
Raw