YouTrack 自定义工作流项目教程

YouTrack 自定义工作流项目教程

youtrack-workflows YouTrack Custom Workflow Repository 项目地址: https://gitcode.com/gh_mirrors/yo/youtrack-workflows

1. 项目目录结构及介绍

youtrack-workflows/
├── js/
│   ├── README.md
│   ├── workflow1.js
│   ├── workflow2.js
│   └── ...
├── .gitignore
├── LICENSE.txt
└── README.md

目录结构说明

• js/: 该目录包含了所有基于 JavaScript API 编写的工作流文件。每个 .js 文件代表一个独立的工作流。
• .gitignore: 用于指定 Git 版本控制系统忽略的文件和目录。
• LICENSE.txt: 项目的许可证文件，本项目使用 Apache-2.0 许可证。
• README.md: 项目的总体介绍文件，包含项目的基本信息和使用说明。

2. 项目的启动文件介绍

在 youtrack-workflows 项目中，没有明确的“启动文件”，因为每个工作流都是独立的 JavaScript 文件。要启动或测试某个工作流，您需要将其上传到 YouTrack 系统中，并在 YouTrack 中启用该工作流。

示例工作流文件

// js/workflow1.js

exports.rule = entities.Issue.onChange({
    title: '自动分配任务',
    action: function(ctx) {
        var issue = ctx.issue;
        if (issue.fields.Assignee === null) {
            issue.fields.Assignee = ctx.currentUser;
        }
    },
    requirements: {
        Assignee: {
            type: entities.User.fieldType
        }
    }
});

启动步骤

1. 将 workflow1.js 文件上传到 YouTrack 系统。
2. 在 YouTrack 中启用该工作流。
3. 工作流将在满足条件时自动执行。

3. 项目的配置文件介绍

在 youtrack-workflows 项目中，没有传统的配置文件（如 .env 或 config.json）。每个工作流的配置是通过 JavaScript 代码中的 requirements 和 action 函数来定义的。

配置示例

// js/workflow2.js

exports.rule = entities.Issue.onChange({
    title: '自动更新状态',
    action: function(ctx) {
        var issue = ctx.issue;
        if (issue.fields.State === 'Open') {
            issue.fields.State = 'In Progress';
        }
    },
    requirements: {
        State: {
            type: entities.EnumField.fieldType,
            name: 'State'
        }
    }
});

配置说明

• title: 工作流的名称。
• action: 工作流的逻辑部分，定义了在满足条件时要执行的操作。
• requirements: 定义了工作流所需的实体和字段类型。

通过这种方式，每个工作流都可以根据具体需求进行灵活配置。

youtrack-workflows YouTrack Custom Workflow Repository 项目地址: https://gitcode.com/gh_mirrors/yo/youtrack-workflows