Enterprise Software Development System

relman CLI: Tasks & Bugs

← Back to the relman CLI command overview

Tasks & bugs

Tasks sit under a project; bugs sit under a task and are only ever reachable through it – there is no “list every bug of a project” shortcut.

list tasks <org-token> <pg-token> <project-token> (aliases: task, t)

Fetches the id and name of every task belonging to the project identified by <project-token>. Tasks are listed flatly, not as the parent/child tree the web UI shows – this command only needs “which tasks does this project have,” not their hierarchy.

describe task <org-token> <pg-token> <project-token> <task-token> (aliases: tasks, t)

Fetches and prints the task’s name, effectively allowed files (the project’s restriction bundles, narrowed by the task’s own whitelist if it has one), description in every translated locale, Definition of Ready, phase, priority, user stories, custom field values, security requirements, and any still-pending or failed automatic description translations.

list bugs <org-token> <pg-token> <project-token> <task-token> (aliases: bug, b)

Fetches the id and name of every bug of the task identified by <task-token>. A bug can only be found this way – there is no “list bugs” for a whole project.

describe bug <org-token> <pg-token> <project-token> <task-token> <bug-token> (alias: b)

Fetches and prints the bug’s name and effectively allowed files (the project’s restriction bundles, narrowed first by its task’s whitelist and then by the bug’s own, each only if it has one).

add bug <org-token> <pg-token> <project-token> <task-token> <name> <definition-of-done-name> [<phase-name>] (alias: b)

Creates a new bug and attaches it to the task identified by <task-token>; <name> becomes the bug’s laboratory name. <definition-of-done-name> is required and matched by name within the project – see describe project‘s “definitionsOfDone” for the available values. [<phase-name>] is optional and matched by name within the project’s organization – see describe project‘s “ticketPhases”; omit it to leave the bug’s phase unset.

Examples

1. Listing a project’s tasks

Global flags (--domain/--cert) are assumed to be set via environment variables and omitted below – see Utility & global flags.

$ relman list tasks o-4kNc8Q pg-8mZ2Lx p-Qv73Tn
- id: t-Nc2Xp8
  name: Checkout redesign
- id: t-Wq91Zk
  name: Fix mobile navigation

Edge case: tasks come back flat, not as the parent/child tree the web UI shows – a sub-task is listed as its own row here with no indication of its parent task.

2. Describing a task

$ relman describe task o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8
name: Checkout redesign
phase: In Progress
priority: 3.5
definitionOfReady: Mockups approved
descriptions:
  - locale: en-US
    text: Redesign the checkout flow for mobile.
userStories: []
customFields: []
securityRequirements: []
pendingTranslations: []

Edge case: pendingTranslations lists any automatic description translation that is still pending or failed, with the failure reason – an empty list means every translation succeeded (or none were ever requested), not that translation is disabled.

3. Creating a bug

$ relman add bug o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8 "Total price flickers on load" "Tested on staging" QA
id: b-P4tRj9

Edge case: "Tested on staging" and QA must match a definitionsOfDone/ticketPhases entry from describe project exactly (see the Organizations & projects page) – omit the trailing phase argument entirely to leave the bug’s phase unset, rather than passing an empty string.

← Zurück zur Übersicht über die relman-CLI-Befehle

Aufgaben und Fehler

Aufgaben sind einem Projekt zugeordnet; Fehler sind einer Aufgabe zugeordnet und nur über diese erreichbar – es gibt keine Abkürzung wie „Alle Fehler eines Projekts auflisten“.

list tasks <org-token> <pg-token> <project-token> (Aliase: task, t)

Ruft die ID und den Namen jeder Aufgabe ab, die zu dem durch <project-token> identifizierten Projekt gehört. Aufgaben werden flach aufgelistet, nicht als Eltern-Kind-Baum, wie ihn die Web-Benutzeroberfläche anzeigt – dieser Befehl benötigt lediglich die Information „Welche Aufgaben hat dieses Projekt?“, nicht deren Hierarchie.

describe task <org-token> <pg-token> <project-token> <task-token> (Aliase: tasks, t)

Ruft den Namen der Aufgabe, die tatsächlich zulässigen Dateien (die Einschränkungsbündel des Projekts, eingeschränkt durch die eigene Whitelist der Aufgabe, falls vorhanden), die Beschreibung in jeder übersetzten Sprachversion sowie die Definition des Status „Bereit“, die Phase, die Priorität, die User Stories, die Werte der benutzerdefinierten Felder, die Sicherheitsanforderungen sowie alle noch ausstehenden oder fehlgeschlagenen automatischen Übersetzungen der Beschreibung.

list bugs <org-token> <pg-token> <project-token> <task-token> (Aliase: bug, b)

Ruft die ID und den Namen jedes Fehlers der durch <task-token> identifizierten Aufgabe ab. Ein Fehler kann nur auf diese Weise gefunden werden – es gibt kein „list bugs“ für ein gesamtes Projekt.

Fehler beschreiben <org-token> <pg-token> <project-token> <task-token> <bug-token> (Alias: b)

Ruft den Namen des Fehlers und die tatsächlich zulässigen Dateien ab und gibt diese aus (die Einschränkungsbündel des Projekts, zunächst durch die Whitelist der Aufgabe und anschließend durch die des Fehlers selbst eingegrenzt, jeweils nur, wenn vorhanden).

add bug <org-token> <pg-token> <project-token> <task-token> <name> <definition-of-done-name> [<phase-name>] (Alias: b)

Erstellt einen neuen Fehler und ordnet ihn der durch <task-token> identifizierten Aufgabe zu; <name> wird zum Labor-Namen des Fehlers. <definition-of-done-name> ist erforderlich und wird innerhalb des Projekts nach Namen abgeglichen – siehe definitionsOfDone“ des Projekts für die verfügbaren Werte. [<phase-name>] ist optional und wird innerhalb der Projektorganisation anhand des Namens abgeglichen – siehe „ticketPhases“ des Projekts; lassen Sie diesen Parameter weg, um die Phase des Fehlers nicht festzulegen.

Beispiele

1. Auflistung der Aufgaben eines Projekts

Globale Flags (--domain/--cert) werden als über Umgebungsvariablen gesetzt vorausgesetzt und im Folgenden weggelassen – siehe „Dienstprogramme & globale Flags“.

$ relman list tasks o-4kNc8Q pg-8mZ2Lx p-Qv73Tn
- id: t-Nc2Xp8
  name: Neugestaltung des Checkouts
- id: t-Wq91Zk
  name: Fehlerbehebung bei der mobilen Navigation

Sonderfall: Aufgaben werden flach dargestellt und nicht als Eltern-Kind-Baum, wie er in der Web-Benutzeroberfläche angezeigt wird – eine Unteraufgabe wird hier als eigene Zeile aufgeführt, ohne Hinweis auf ihre übergeordnete Aufgabe.

2. Eine Aufgabe beschreiben

$ relman describe task o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8
name: Neugestaltung des Checkout-Prozesses
phase: In Bearbeitung
priority: 3,5
definitionOfReady: Mockups genehmigt
descriptions:
  - Sprache: en-US
    Text: Neugestaltung des Checkout-Ablaufflußes für Mobilgeräte.
User Stories: []
Benutzerdefinierte Felder: []
Sicherheitsanforderungen: []
Ausstehende Übersetzungen: []

Sonderfall: „pendingTranslations“ listet alle automatischen Übersetzungen von Beschreibungen auf, die noch ausstehen oder fehlgeschlagen sind, einschließlich des Fehlersgrundes – eine leere Liste bedeutet, dass alle Übersetzungen erfolgreich waren (oder gar keine angefordert wurden), nicht, dass die Übersetzung deaktiviert ist.

3. Einen Bug erstellen

$ relman add bug o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8 „Gesamtpreis flackert beim Laden“ „Auf Staging getestet“ QA
id: b-P4tRj9

Sonderfall: „Auf Staging getestet“ und QA müssen exakt mit einem Eintrag aus„definitionsOfDone/ticketPhases“ aus „describe project“ übereinstimmen (siehe die Seite „Organisationen & Projekte“ ) – lassen Sie das abschließende Phasenargument vollständig weg, um die Phase des Fehlers nicht festzulegen, anstatt eine leere Zeichenkette zu übergeben.

← Retour à la présentation des commandes de l’interface en ligne de commande (CLI) de relman

Tâches et bogues

Les tâches sont rattachées à un projet ; les bogues sont rattachés à une tâche et ne sont accessibles que par son intermédiaire — il n’existe pas de raccourci permettant de « lister tous les bogues d’un projet ».

list tasks <org-token> <pg-token> <project-token> (alias : task, t)

Récupère l’identifiant et le nom de chaque tâche appartenant au projet identifié par <project-token>. Les tâches sont répertoriées de manière plate, et non sous la forme d’une arborescence parent/enfant comme dans l’interface web : cette commande a uniquement besoin de savoir « quelles tâches ce projet contient », et non leur hiérarchie.

describe task <org-token> <pg-token> <project-token> <task-token> (alias : tasks, t)

Récupère et affiche le nom de la tâche, les fichiers effectivement autorisés (les ensembles de restrictions du projet, restreints par la liste blanche propre à la tâche si celle-ci en possède une), la description dans toutes les langues traduites, la définition de l’état « Prêt », la phase, la priorité, les user stories, les valeurs des champs personnalisés, les exigences de sécurité, ainsi que les traductions automatiques de la description encore en attente ou ayant échoué.

list bugs <org-token> <pg-token> <project-token> <task-token> (alias : bug, b)

Récupère l’identifiant et le nom de chaque bug de la tâche identifiée par <task-token>. Un bug ne peut être trouvé que de cette manière — il n’existe pas de commande « list bugs » pour l’ensemble d’un projet.

describe bug <org-token> <pg-token> <project-token> <task-token> <bug-token> (alias : b)

Récupère et affiche le nom du bug ainsi que les fichiers effectivement autorisés (les ensembles de restrictions du projet, d’abord restreints par la liste blanche de la tâche, puis par celle du bug lui-même, à condition qu’il en ait une).

add bug <org-token> <pg-token> <project-token> <task-token> <name> <definition-of-done-name> [<phase-name>] (alias : b)

Crée un nouveau bug et le rattache à la tâche identifiée par <task-token>; <name> devient le nom de laboratoire du bug. <definition-of-done-name> est obligatoire et doit correspondre à un nom existant au sein du projet — voir la section « definitionsOfDone » du projet pour connaître les valeurs disponibles. [<nom-de-phase>] est facultatif et doit correspondre à un nom au sein de l’organisation du projet — voir la section « ticketPhases » de la description du projet; omettez-le pour laisser la phase du bug non définie.

Exemples

1. Liste des tâches d’un projet

Les indicateurs globaux (--domain/--cert) sont supposés être définis via des variables d’environnement et sont omis ci-dessous — voir Utilitaires et indicateurs globaux.

$ relman list tasks o-4kNc8Q pg-8mZ2Lx p-Qv73Tn
- id : t-Nc2Xp8
  nom : Refonte du processus de paiement
- id : t-Wq91Zk
  nom : Correction de la navigation mobile

Cas particulier : les tâches s’affichent à plat, et non sous forme d’arborescence parent/enfant comme dans l’interface utilisateur Web — une sous-tâche apparaît ici sur une ligne distincte, sans indication de sa tâche parente.

2. Description d’une tâche

$ relman describe task o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8
nom : Refonte du processus de paiement
phase : En cours
priorité : 3,5
définition de « prêt » : Maquettes approuvées
descriptions :
  - locale : en-US
    text : Refonte du processus de paiement sur mobile.
userStories : []
customFields : []
securityRequirements : []
pendingTranslations : []

Cas particulier : la liste « traductions en attente » répertorie toutes les traductions automatiques de descriptions qui sont encore en attente ou qui ont échoué, avec la raison de l’échec. Une liste vide signifie que toutes les traductions ont réussi (ou qu’aucune n’a jamais été demandée), et non que la traduction est désactivée.

3. Création d’un bug

$ relman add bug o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8 "Le prix total clignote au chargement" "Testé en préproduction" QA
id : b-P4tRj9

Cas particulier : « Testé sur l'environnement de préproduction » et « QA » doivent correspondre exactement à une entréede `definitionsOfDone/ticketPhases ` du projet `describe` (voir la page Organisations et projets ) — omettez complètement l’argument de phase final pour laisser la phase du bug non définie, plutôt que de passer une chaîne vide.

← Volver al resumen de comandos de la CLI de relman

Tareas y errores

Las tareas se encuentran bajo un proyecto; los errores se encuentran bajo una tarea y solo se puede acceder a ellos a través de esta; no existe un atajo para «mostrar todos los errores de un proyecto».

list tasks <org-token> <pg-token> <project-token> (alias: task, t)

Recupera el identificador y el nombre de todas las tareas que pertenecen al proyecto identificado por <identificador-del-proyecto>. Las tareas se enumeran de forma plana, no como el árbol de padres e hijos que muestra la interfaz de usuario web; este comando solo necesita saber «qué tareas tiene este proyecto», no su jerarquía.

describe task <org-token> <pg-token> <project-token> <task-token> (alias: tasks, t)

Recupera y muestra el nombre de la tarea, los archivos efectivamente permitidos (los paquetes de restricciones del proyecto, filtrados por la lista blanca de la propia tarea si dispone de ella), la descripción en todas las configuraciones regionales traducidas, la definición de «Listo», la fase, la prioridad, las historias de usuario, los valores de los campos personalizados, los requisitos de seguridad y cualquier traducción automática de la descripción que aún esté pendiente o haya fallado.

list bugs <org-token> <pg-token> <project-token> <task-token> (alias: bug, b)

Recupera el ID y el nombre de todos los errores de la tarea identificada por <task-token>. Solo se puede buscar un error de esta manera; no existe un comando «list bugs» para todo un proyecto.

describe bug <org-token> <pg-token> <project-token> <task-token> <bug-token> (alias: b)

Recupera y muestra el nombre del error y los archivos efectivamente permitidos (los paquetes de restricciones del proyecto, filtrados primero por la lista blanca de la tarea y luego por la del propio error, cada uno de ellos solo si existe).

añadir error <token-org> <token-pg> <token-proyecto> <token-tarea> <nombre> <definición-del-nombre-de-finalización> [<nombre-fase>] (alias: b)

Crea un nuevo error y lo vincula a la tarea identificada por <task-token>; <name> se convierte en el nombre de laboratorio del error. <definition-of-done-name> es obligatorio y debe coincidir con un nombre dentro del proyecto; consulta «definitionsOfDone» del proyecto para ver los valores disponibles. [<nombre-de-fase>] es opcional y se compara por nombre dentro de la organización del proyecto; consulta la sección «ticketPhases» del proyecto; omítelo para dejar la fase del error sin establecer.

Ejemplos

1. Listado de las tareas de un proyecto

Se da por hecho que los indicadores globales (--domain/--cert) están configurados mediante variables de entorno y, por lo tanto, se omiten a continuación; véase Utilidades e indicadores globales.

$ relman list tasks o-4kNc8Q pg-8mZ2Lx p-Qv73Tn
- id: t-Nc2Xp8
  nombre: Rediseño del proceso de pago
- id: t-Wq91Zk
  nombre: Corregir la navegación en dispositivos móviles

Caso especial: las tareas se muestran de forma plana, no como el árbol de tareas principales y secundarias que muestra la interfaz de usuario web; aquí, una subtarea aparece en su propia fila sin indicación alguna de su tarea principal.

2. Descripción de una tarea

$ relman describe task o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8
nombre: Rediseño del proceso de pago
fase: En curso
prioridad: 3,5
definición de «listo»: Maquetas aprobadas
descripciones:
  - configuración regional: en-US
    texto: Rediseñar el flujo de pago para dispositivos móviles.
historias de usuario: []
campos personalizados: []
requisitos de seguridad: []
traducciones pendientes: []

Caso especial: «traducciones pendientes» enumera cualquier traducción automática de descripciones que aún esté pendiente o haya fallado, indicando el motivo del fallo; una lista vacía significa que todas las traducciones se han realizado correctamente (o que nunca se solicitó ninguna), no que la traducción esté desactivada.

3. Crear un error

$ relman add bug o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8 «El precio total parpadea al cargarse» «Probado en el entorno de staging» QA
id: b-P4tRj9

Caso especial: «Probado en el entorno de pruebas» y QA deben coincidir exactamente con una entradade definitionsOfDone/ticketPhases del proyecto describe (véase la página «Organizaciones y proyectos» ); omite por completo el argumento de fase final para dejar la fase del error sin definir, en lugar de pasar una cadena vacía.

← 返回 relman CLI 命令概述

任务与缺陷

任务隶属于项目;缺陷隶属于任务,且只能通过任务访问——不存在“列出某个项目的所有缺陷”的快捷方式。

list tasks <org-token> <pg-token> <project-token> (别名:task,t)

获取属于由<project-token> 标识的项目中的每个任务的 ID 和名称。任务以扁平列表形式显示,而非 Web 界面中显示的父子树结构——此命令仅需了解“该项目包含哪些任务”,而非其层级结构。

describe task <org-token> <pg-token> <project-token> <task-token> (别名:tasks,t

获取并输出任务的名称、实际允许的文件(即项目的限制包,若任务本身有白名单则会进一步筛选)、各翻译语言版本中的描述、 “就绪”状态的定义、阶段、优先级、用户故事、自定义字段值、安全要求,以及任何仍待处理或失败的自动描述翻译。

list bugs <org-token> <pg-token> <project-token> <task-token> (别名:bug,b

获取由<task-token> 标识的任务中每个缺陷的 ID 和名称。缺陷只能通过此方式查找——不存在针对整个项目的“list bugs”命令。

describe bug <org-token> <pg-token> <project-token> <task-token> <bug-token> (别名:b

获取并打印缺陷的名称及其实际允许的文件(即项目的限制包,先由任务的白名单进行筛选,再由缺陷自身白名单进行筛选,且两项筛选均仅在存在相应白名单时生效)。

add bug <org-token> <pg-token> <project-token> <task-token> <name> <definition-of-done-name> [<phase-name>] (别名:b)

创建一个新缺陷并将其关联到由<task-token> 标识的任务;<name>将成为该缺陷的实验室名称。<definition-of-done-name>为必填项,需与项目内的名称匹配——可用值请参见项目“definitionsOfDone”的描述[<阶段名称>]为可选字段,需与项目组织内的名称匹配——请参阅项目描述中的“ticketPhases”;若省略该字段,则该缺陷的阶段保持未设置。

示例

1. 列出项目的任务

全局标志(--domain/--cert)默认通过环境变量设置,因此下文中省略——请参阅“实用工具与全局标志”

$ relman list tasks o-4kNc8Q pg-8mZ2Lx p-Qv73Tn
- id: t-Nc2Xp8
  名称: 结账页面重新设计
- id: t-Wq91Zk
  名称: 修复移动端导航

边界情况:任务以扁平化形式显示,而非 Web 界面中呈现的父子树结构——子任务在此处被列为独立行,且未标注其父任务。

2. 描述任务

$ relman describe task o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8
名称:结账流程重新设计
阶段:进行中
优先级:3.5
就绪定义:设计稿已获批准
描述:
  - 语言环境:en-US
    文本:重新设计移动端的结账流程。
用户故事:[]
自定义字段:[]
安全要求:[]
待翻译项:[]

边界情况: pendingTranslations列出了所有仍处于待处理或已失败的自动描述翻译,并附有失败原因——空列表表示所有翻译均成功(或从未请求过翻译),而非表示翻译已被禁用。

3. 创建错误报告

$ relman add bug o-4kNc8Q pg-8mZ2Lx p-Qv73Tn t-Nc2Xp8 "加载时总价闪烁" "已在预发布环境测试" QA
id: b-P4tRj9

边界情况: “已在预发布环境测试”QA必须与describe projectdefinitionsOfDone/ticketPhases条目完全匹配(参见“组织与项目”页面)——应完全省略末尾的阶段参数以使问题处于未设置阶段,而不是传递空字符串。

Top