Youtrack logo

The YouTrack Blog

The Issue Tracking and Project Management Tool for Teams

YouTrack ワークフロー API の現状

しばらく前に、レガシーワークフローのサポートが YouTrack 2019.1 で中止となることを発表しました

レガシーワークフローとは、バージョン 2018.3 で使用廃止となった古い外部アプリケーションのワークフローエディターで記述されたワークフローのことです。

一部のお客様は依然としてこれらのレガシーワークフローをご利用のようです。 機能の使用状況の統計によれば、約 6.5% の YouTrack InCloud インスタンスで 1 つ以上のレガシーワークフローが有効化されています。 そのため、後 6 か月間は取り残すことに決定しました。このレガシーワークフローは、バージョン 2019.3 で動作停止となります。

とはいえ、できるだけ早めにレガシーワークフローをアップグレードすることを強くお勧めします。 古いエディターを利用できない(古いルールが使用されているものは変更できません)ということだけではなく、新しい API の性能と有用性ははるかに改善されています。 一部の新機能は古い API ではサポートされていないため、たとえば、アクションルールを実装することができません。

ワークフローをアップグレードするには、次の手順を実行してください。

1. アクティブなレガシーワークフローが残っていないか確認します。 確認するには、YouTrack サーバーの Workflows ページに移動し、リンク形式ではなくプレーンテキスト形式でのタイトルが付いたワークフローがあるか確認します。

LegacyWorkflows

2. レガシーワークフローには、バージョン 2017.3 より前の YouTrack インストールで提供されていたものが含まれているかもしれません。こういったワークフローの名前は、「jetbrains-youtrack-」で始まります。 可能な場合には新しいワークフロー API に自動アップグレードを実施していますが、古いワークフローエディタで編集されているワークフローはアップグレードできていません。

変更の意図がまったくないワークフローを特定してください。 アップグレードするには、それらを選択して “Restore Selected” ボタンをクリックします。

RestoreWorkflow

3. なんらかの理由により変更したことのあるデフォルトのワークフローがある場合は、ドキュメントの「デフォルトワークフロー」セクションに記載の対応する JS ワークフローを参考にすることをお勧めします。

たとえば、「Due Date」ワークフローの「Don’t allow to submit issue without Due date set」ルールを変更済みのメッセージに使用している場合は、次のように行う必要があります。

  • ウェブベースのエディタでワークフローを作成します。
  • 新しいモジュールを追加します。
  • 次のルールのテキストをコピーします。
  • メッセージを編集します。
  • ワークフローを保存して、対応するプロジェクトに添付します。

DueDateDefaultWorkflow

4. その他のレガシーワークフローは一般に公開されているワークフローレポジトリからのワークフローである場合があります。 これらをアップグレードするには、リポジトリに移動し、対応するワークフローを検索して、古いワークフローを新しいワークフローに置き換えます。

Repository

5. 上記に該当しないレガシーワークフローがまだ存在する場合は、新しい API で書き直す必要があります。 まだ書き直したことがない場合は、ウェビナーを見て、クイックスタートガイドに目を通すことをお勧めします。

6. 書き直しのプロセスを高速化できるよう、ワークフローコンバータを実装しました。 ただし、このコンバータは完全に自動化されているため、それが生成するワークフローの品質は手動で記述したコードに劣ってしまいます。

レガシーワークフローをアップグレードするには、次を行います。

  • レガシーワークフローをエクスポートします。
  • JetBrains YouTrack ワークフローコンバータに移動します。
  • エクスポートした ZIP ファイルをそこにアップロードし、処理が終わるまでしばらく待ちます。

WorkflowConverter

ワークフローのアップグレードに関するご質問やサポートが必要な場合は、サポートチームにご連絡いただくか、Slack の YouTrack Community にご参加ください。 いつでもお手伝いいたします!

Discover more