Jenkins プラグイン

このプラグインを使用すると、UiPath のオートメーション プロセスを構築およびデプロイできます。また、UiPath の自動化されたテスト ケースも実行できます。

v2020.10 以降の UiPath Studio で作成されたプロジェクトをパッケージ化するには、この拡張機能の 2.1 以降のバージョンを使用する必要があります。

前提条件

• Windows または Linux で実行されている Jenkins サーバー
• Windows 上で実行されている 1 つ以上の Jenkins スレーブ (ステップの実行に必要)

• Orchestrator インスタンス (基本、フェデレーション、またはクラウド認証がサポートされています)

  • テスト機能には、Orchestrator バージョン 2020.4 以降が必要です。
  • HTTPS 下のオンプレミスの Orchestrator を使用している場合は、Orchestrator への HTTPS 呼び出しが信頼されるように、必ず SSL 証明書をインポートしてください。

プラグインをインストールして有効化する

Jenkins プラグインは、インターネットに接続されている任意の Jenkins インストールから、プラグイン マネージャー画面を使用してインストールできます。

ジョブ

UiPath のジョブを実行

ビルド後のステップ [UiPath のジョブを実行] は、Orchestrator インスタンスに既にデプロイされているプロセスを開始します。v2020.10 の Orchestrator では、このタスクによって実行されるプロセスを [プロセス] タブで確認できます。v2021.10 以降の Orchestrator では、このタスクによって実行されるプロセスを [オートメーション] の [プロセス] で確認できます。

構成

ジョブのパラメーター	説明
プロセス (必須)	プロセス名です。プロセス名は Orchestrator の UI から取得できます。 プロセスがモダン フォルダーにデプロイされている場合、この引数は [プロセス] タブに表示されているプロセスの [名前] である必要があります。プロセスがクラシック フォルダーにデプロイされている場合、この引数はプロセスの [名前] と [ロボット グループ] の組み合わせ (例: 名前が ProcessA でロボット グループが Production の場合: ProcessA_Production) で設定する必要があります。
パラメーター	JSON 入力ファイルのフル パスです。プロセスが入力を必要とする場合に使用されます。 JSON ファイル形式の例: { "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }
優先度	ジョブの実行の優先度です。
ストラテジ	ジョブの実行ストラテジとして、ジョブを動的に割り当てるか、特定のロボットに割り当てるかを指定します。次のいずれかのオプションから選択します。 動的に割り当て 特定のロボット
ジョブの種類 (モダン フォルダーでのみ使用可能)	ジョブを実行するランタイムのライセンス モデルを選択します。
Orchestrator のアドレス	プロセスを実行する Orchestrator インスタンスのアドレスです。
Orchestrator テナント	Orchestrator テナントを指定します。
Orchestrator のフォルダー	指定したプロセスがデプロイされたフォルダーを指定します。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
認証	Orchestrator に対する認証を行うには、Jenkins で事前に資格情報を作成する必要があります。認証には、次の 4 つの方法があります。 (1) ユーザー名とパスワードを使用してオンプレミスの Orchestrator に認証する (2) 更新トークン (API キー) を使用してクラウドの Orchestrator に認証する (3) 外部アプリの認証を使用してクラウドの Orchestrator に認証する (4) 外部アプリの認証を使用して、オンプレミスの Orchestrator に認証する
ジョブ結果の出力パス	ジョブの結果の出力パスを指定します (例: testResults.json)。結果は、JSON 形式で出力されます。 指定しない場合は、成果物のステージング ディレクトリに UiPathResults.json として出力されます。出力は、JSON 形式です。
Timeout	ジョブの実行のタイムアウトを秒単位で指定します。
ジョブの失敗時に失敗	少なくとも 1 つのジョブが失敗すると、タスクが失敗します。既定値は [True] です。
ジョブの完了まで待機	ジョブの実行が完了するまで待機します。既定値は [True] です。
ログのトレース レベル	トレース ログを以下のいずれかのレベルで有効化するために使用する設定です。 None Critical Error Warning Information Verbose (既定では [None] に設定) デバッグに便利です。
ジョブの数	ジョブの実行回数です。既定値は 1 です。
ユーザー (モダン フォルダーでのみ使用可能)	ユーザーの名前です。ユーザーは、Orchestrator のユーザーではなくマシンのユーザーである必要があります。 ローカル ユーザーの場合、MachineName\UserName の形式で指定します。
マシン (モダン フォルダーでのみ使用可能)	マシンの名前です。
ロボット名	コンマで区切られた特定のロボット名のリストです。

パイプラインの例

pipeline {
  agent any
  environment {
      MAJOR = '1'
      MINOR = '0'
  }
  stages {
    stage ('Build') {
        UiPathRunJob(
          credentials: UserPass('825c83c9-9a14-44eb-883a-af54f8078af0'),
          failWhenJobFails: true,
          folderName: 'A_Classic',
          orchestratorAddress: 'https://testorchestrator.some-domain.com',
          orchestratorTenant: 'Default',
          parametersFilePath: '',
          priority: 'Low',
          processName: 'ProcessA_EnvB',
          resultFilePath: 'output.json',
          strategy: Dynamically(jobsCount: 1, machine: 'TestMachine', user: 'TestUser'), timeout: 3600, waitForJobCompletion: true, traceLoggingLevel: 'None'
        )
        UiPathRunJob(
          credentials: UserPass('825c83c9-9a14-44eb-883a-af54f8078af0'),
          failWhenJobFails: true,
          folderName: 'A_Classic',
          orchestratorAddress: 'https://testorchestrator.some-domain.com',
          orchestratorTenant: 'Default',
          parametersFilePath: '',
          priority: 'Low',
          processName: 'ProcessA_EnvB',
          resultFilePath: 'output.json',
          strategy: Robot('robot1,robot2'),
          timeout: 1800,
          waitForJobCompletion: false,
          traceLoggingLevel: 'None'
        )
    }
  }
}

UiPath のアセットを管理

[UiPath のアセットを管理] の手順では、Orchestrator インスタンスのアセットをデプロイ、更新、削除できます。アセットをデプロイするには、下の例のように、uft-8 でエンコードされた CSV ファイルでアセットを記述する必要があります。

name,type,value,description
asset_1_name,text,asset_value,this is an test description   # we can have comments
asset_2_name,integer,123
asset_3_name,boolean,false
asset_4_name,credential,"username::password"

アセットには次の 4 つの種類があります。

• テキスト
• Integer
• Boolean
• 資格情報です。ユーザー名とパスワードをエンコードする必要があります。:: を使用して 2 つのフィールドを区切ります。
  
  

  

  
  

構成

ジョブのパラメーター	説明
操作	指定したアセットに対してデプロイまたは削除を実行できます。デプロイされたアセットが存在する場合は、更新されます。
Orchestrator のアドレス	アセットをデプロイまたは更新する Orchestrator インスタンスのアドレスです。
Orchestrator テナント	アセットをデプロイまたは更新する Orchestrator テナントを指定します。
Orchestrator のフォルダー	アセットをデプロイまたは更新するフォルダーを指定します。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
認証	Orchestrator に対する認証を行うには、Jenkins で事前に資格情報を作成する必要があります。認証には、次の 4 つの方法があります。 (1) ユーザー名とパスワードを使用してオンプレミスの Orchestrator に認証する (2) 更新トークン (API キー) を使用してクラウドの Orchestrator に認証する (3) 外部アプリの認証を使用してクラウドの Orchestrator に認証する (4) 外部アプリの認証を使用してオンプレミスの Orchestrator に認証する
CSV ファイルのパス	アセットの詳細を含む CSV ファイルへのパスです。アセットのデプロイまたは更新にも同じファイルを使用できますが、更新の場合には type は不要です。 type フィールドは空でも問題ありませんが、列自体は存在する必要があります。アセットを削除する場合は name 列のみが使用されるため、他の列は空にできますが、列自体は存在する必要があります。 必要に応じて、各アセットの説明を設定できます (例: type, value, description)。各行が新しいアセットとして解釈されるため、改行は必ず削除してください。
ログのトレース レベル	トレース ログを以下のいずれかのレベルで有効化するために使用する設定です。 None Critical Error Warning Information Verbose (既定では [None] に設定) デバッグに便利です。

パイプラインの例

pipeline {
  agent any
  environment {
      MAJOR = '1'
      MINOR = '0'
  }
  stages {
    stage ('Build') {
        UiPathAssets (
            assetsAction: DeployAssets(), 
            credentials: Token(accountName: '', credentialsId: ''), 
            filePath: '${WORKSPACE}/test.csv', 
            folderName: 'Default', 
            orchestratorAddress: 'https://test-orchestrator.somedomain.com', 
            orchestratorTenant: 'Default',
            traceLoggingLevel: 'None'
        )
        UiPathAssets(
            assetsAction: DeleteAssets(),
            credentials: UserPass('825c83c9-9a14-44eb-883a-af54f8078af0'),
            filePath: '${WORKSPACE}/test.csv',
            folderName: 'Default',
            orchestratorAddress: 'https://test-orchestrator.somedomain.com',
            orchestratorTenant: 'Default',
            traceLoggingLevel: 'None'
        )
    }
  }
}

UiPath の Nuget パッケージをパブリッシュ

アプリケーション: RPA

種類: Build task

[UiPath の Nuget パッケージをパブリッシュ] タスクは標準のジョブおよびパイプラインで利用でき、既存の UiPath プロジェクトを NuGet パッケージ化できます。

構成

ジョブのパラメーター	説明
バージョン管理メソッドを選択	UiPath のパッケージはバージョン管理されています。[UiPath の Nuget パッケージをパブリッシュ] タスクでは、次の 3 つの異なるオプションから選択できます。 (1) 自動生成 (2) ユーザー設定のパッケージのバージョン管理を使用 (3) プロジェクトで設定されている現在のバージョンを使用
プロジェクトのパス	パッケージ化するプロジェクトの場所です。project.json ファイル、または 1 つ以上のプロジェクトを含むディレクトリへの直接パスを選択できます。後者の場合は、レベル 1 の各プロジェクトは個別にパッケージ化されます。
出力フォルダー	パッケージを作成するフォルダーへのパスです。
出力の種類	プロジェクトの出力の種類です。プロジェクトの種類には、次の 5 つのオプションがあります。 (1) Output type of the project (2) Pack a process project (3) Pack a library project (4) Pack a tests project (5) Pack an objects project
ワークフローの分析を実行	パッケージ化の前にワークフロー分析を実行し、あらかじめ定義されたルールの違反がプロジェクトにないかを確認します。エラーが検出されるとジョブは失敗します。既定では、分析は実行されません。
ログのトレース レベル	トレース ログを以下のいずれかのレベルで有効化するために使用する設定です。 None Critical Error Warning Information Verbose (既定では [None] に設定) デバッグに便利です。
Orchestrator を使用	ライブラリをパッケージ化するときに Orchestrator のフィードを使用します。v20.4 以降の Orchestrator が必要です。また、[テナント] > [設定] > [デプロイ] でライブラリ フィードの API キー認証を許可する必要があります。
Orchestrator のアドレス	ライブラリの依存関係の復元元である Orchestrator インスタンスのアドレスです。
Orchestrator テナント	ライブラリの依存関係の復元元となる Orchestrator テナントです。
認証	Orchestrator に対する認証を行うには、Jenkins で事前に資格情報を作成する必要があります。認証には、次の 4 つの方法があります。 (1) ユーザー名とパスワードを使用してオンプレミスの Orchestrator に認証する (2) 更新トークン (API キー) を使用してクラウドの Orchestrator に認証する (3) 外部アプリの認証を使用してクラウドの Orchestrator に認証する (4) 外部アプリの認証を使用して、オンプレミスの Orchestrator に認証する

パイプラインの例

ipeline {
  agent any
  environment {
      MAJOR = '1'
      MINOR = '0'
  }
  stages {
    stage ('Build') {
      steps {
        UiPathPack (
          outputPath: "Output\)\)\)\)${env.BUILD_NUMBER}",
          projectJsonPath: "UiBank\)\)\)\)project.json",
          version: [$class: 'ManualVersionEntry', version: "${MAJOR}.${MINOR}.${env.BUILD_NUMBER}"]
          useOrchestrator: true,
          traceLoggingLevel: "None",
          orchestratorAddress: "OrchestratorUrl",
          orchestratorTenant: "tenant name",
          credentials: [$class: 'UserPassAuthenticationEntry', credentialsId: “credentialsId”]
        )
      }
    }
  }
}

UiPath の NuGet パッケージをデプロイ

アプリケーション: RPA

種類: Post build task

[UiPath の NuGet パッケージをデプロイ] は、標準のジョブおよびパイプラインで使用でき、UiPath NuGet パッケージを UiPath Orchestrator にデプロイできます。

構成

ジョブのパラメーター	説明
パッケージのパス	UiPath NuGet パッケージが格納されているフォルダーです。
Orchestrator のアドレス	パッケージをデプロイする Orchestrator インスタンスのアドレスです。
Orchestrator テナント	パッケージをデプロイする Orchestrator テナントです。
Orchestrator のフォルダー	デプロイ先のフォルダーです。フォルダーがクラシック フォルダーの場合、[ロボット グループ] のフィールドも設定する必要があります。モダン フォルダーの場合は、[ロボット グループ] フィールドの設定は不要です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
ロボット グループ (クラシック フォルダーの場合は必須)	パッケージをプロセスとしてデプロイするロボット グループです。既存のプロセスがあるプロジェクトとロボット グループでは、プロセスが更新され、最新のプロジェクト バージョンが使用されます。パッケージをプロセスとしてデプロイするロボット グループを指定します。既存のプロセスがあるプロジェクトとロボット グループでは、プロセスが更新され、最新のプロジェクト バージョンが使用されます。
エントリ ポイント	プロセスを作成または更新するエントリ ポイントを指定します。このエントリ ポイントは、プロジェクトのルートから開始するファイル パスを指定します。 条件: エントリ ポイントは、v21.4 以降の Orchestrator で使用できます (例: 21.4.UiPathDeploy.entryPoints)。v21.4 未満の Orchestrator の場合は、任意の値を入力する必要があります。フィールドを空のままにすることはできません。 既定のエントリ ポイントは Main.xaml に設定されています。 クラシック フォルダー (非推奨) の場合は、1 つのロボット グループに 1 つのエントリ ポイントのみ指定できます。 詳細については、『Orchestrator ガイド』の「エントリ ポイント」をご覧ください。
認証	Orchestrator に対する認証を行うには、Jenkins で事前に資格情報を作成する必要があります。認証には、次の 4 つの方法があります。 (1) ユーザー名とパスワードを使用してオンプレミスの Orchestrator に認証する (2) 更新トークン (API キー) を使用してクラウドの Orchestrator に認証する (3) 外部アプリの認証を使用してクラウドの Orchestrator に認証する (4) 外部アプリの認証を使用してオンプレミスの Orchestrator に認証する
ログのトレース レベル	トレース ログを以下のいずれかのレベルで有効化するために使用する設定です。 None Critical Error Warning Information Verbose (既定では [None] に設定) デバッグに便利です。

注:

お使いのネットワークで、以下の NuGet パッケージ フィードへのアクセスが許可されていることを確認してください。

• https://api.nuget.org/v3/index.json
• https://uipath.pkgs.visualstudio.com/_packaging/nuget-packages/nuget/v3/index.json
• https://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-* Internal/nuget/v3/index.json
• https://www.myget.org/F/workflow
• http://www.myget.org/F/uipath
• https://www.myget.org/F/uipath-dev/api/v3/index.json

パイプラインの例

pipeline {
  agent any
  environment {
      MAJOR = '1'
      MINOR = '0'
  }
  stages {
    stage ('PostBuild') {
      steps {
        UiPathDeploy (
          packagePath: "path\)\)\)    o\)\)NuGetpackage",
          orchestratorAddress: "OrchestratorUrl",
          orchestratorTenant: "tenant name",
          folderName: "folder name",
          environments: "environment",
          credentials: [$class: 'UserPassAuthenticationEntry', credentialsId: “credentialsId”],
          traceLoggingLevel: 'None'
        )
      }
    }
  }
}

UiPath のテストを実行

アプリケーション: テスト

種類: Post build task

[UiPath のテストを実行] は、標準ジョブとパイプラインで利用でき、以下を実行できます。

• Orchestrator 内の既存のテスト セットを実行する
• UiPath テスト プロジェクトへのパスを指定して、テスト ケースをパッケージ化、デプロイ、実行する

テスト実行が完了すると、Jenkins ビルドに [テスト結果] タブが公開され、詳細な結果が表示されます。さらに、指定したテスト結果の出力パスに JUnit テスト結果ファイルが作成されます。指定しない場合は、ワークスペースのルートに作成されます。

結果に応じて、ビルドは成功 (すべてのテスト ケースが合格) または不安定 (少なくとも 1 つのテスト ケースが不合格) とマークされます。

構成

ジョブのパラメーター	説明
ターゲット	UiPath Orchestrator 上の既存のテスト セットを指定します (テスト セットを実行する場合)。 UiPath テスト プロジェクトの project.json パスを指定します (テスト プロジェクトを実行する場合)。
テスト結果の出力パス	実行されたテスト セットは、テスト結果を junit.xml として返します。結果を保存するパスを、Jenkins ワークスペースのディレクトリに対する相対パスで指定します (例: result.xml)。
入力パラメーター	テスト ケースのカスタム引数を定義して、テスト セット レベルで既定値を上書きします。この引数を使用して、実行時にテスト ケースにパラメーターを設定できます。引数を定義するには、引数を含むパッケージをパブリッシュしておく必要があります。
Orchestrator のアドレス	パッケージをデプロイする Orchestrator インスタンスのアドレスです。
Orchestrator テナント	パッケージをデプロイする Orchestrator テナントです。
Orchestrator のフォルダー	デプロイ先のフォルダーです。 フォルダーがクラシック フォルダーの場合、[ロボット グループ] フィールドも設定する必要があります。 モダン フォルダーの場合は、[ロボット グループ] の設定は不要です。 サブフォルダーを入力するには、親フォルダーの名前とサブフォルダーの名前の両方を入力してください。例: AccountingTeam\TeamJohn
ロボット グループ (クラシック フォルダーの場合は必須)	パッケージをプロセスとしてデプロイするロボット グループです。既存のプロセスがあるプロジェクトとロボット グループでは、プロセスが更新され、最新のプロジェクト バージョンが使用されます。パッケージをプロセスとしてデプロイするロボット グループを指定します。既存のプロセスがあるプロジェクトとロボット グループでは、プロセスが更新され、最新のプロジェクト バージョンが使用されます。
認証	Orchestrator に対する認証を行うには、Jenkins で事前に資格情報を作成する必要があります。認証には、次の 4 つの方法があります。 (1) ユーザー名とパスワードを使用してオンプレミスの Orchestrator に認証する (2) 更新トークン (API キー) を使用してクラウドの Orchestrator に認証する (3) 外部アプリの認証を使用してクラウドの Orchestrator に認証する (4) 外部アプリの認証を使用してオンプレミスの Orchestrator に認証する
タイムアウト (秒)	テスト実行の実行タイムアウトです。既定値は 7200 秒です。Orchestrator での実行が完了する前にタイムアウト値を超え、結果が返された場合、ビルドはキャンセルされ、失敗としてマークされます。
ログのトレース レベル	トレース ログを以下のいずれかのレベルで有効化するために使用する設定です。 None Critical Error Warning Information Verbose (既定では [None] に設定) デバッグに便利です。

パイプラインの例

pipeline {
  agent any
  environment {
    MAJOR = '1'
    MINOR = '0'
  }
  stages {
    stage ('PostBuild') {
      steps {
        UiPathTest (
          testTarget: [$class: 'TestSetEntry', testSet: "My Test Set"],
          orchestratorAddress: "OrchestratorUrl",
          orchestratorTenant: "tenant name",
          folderName: "folder name",
          timeout: "10000",
          traceLoggingLevel: 'None',
          testResultsOutputPath: "result.xml",
          credentials: [$class: 'UserPassAuthenticationEntry', credentialsId: "credentialsId"]
        )
      }
    }
  }
}

Cloud Orchestrator の API キーを取得する

外部アプリのサービス接続を設定する

手順 1: 外部アプリケーションとスコープを設定します。アプリケーションを追加した後は、次の手順で使用するアプリ ID、シークレット、アプリケーション スコープをメモしておきます。

注: 新しいシークレットを生成して使用すると、古いシークレットは無効になります。

手順 2: Jenkins でアプリケーション資格情報をシークレット テキストとして設定します。この手順では、Automation Cloud で生成されたシークレットが必要です。

手順 3: アカウント名と、その後に Automation Cloud で生成されたアプリ ID、シークレット、アプリケーション スコープを追加して、Post-Build Actions 下の各タスクの認証を設定します。

注: 無効化のエラーを回避するため、外部アプリを個々のパイプラインで使用することを検討してください。

その他の情報

• 指定するすべてのパスは、現在のワークスペースのローカルである必要があります。パスで環境変数を使用する場合でも、パスが必ずワークスペースのローカルになるようにしてください。
• パッケージをデプロイする、またはテストを実行する場合、認証されたユーザーにフォルダーの表示 (または 組織単位の表示) および (20.4 以降 の場合み) バックグラウンド タスクの表示権限があることを確認してください。
• ライブラリをパッケージ化する際、Orchestrator インスタンスに接続されている場合は、認証されたユーザーがライブラリの表示権限を持っている必要があります。

• 外部アプリの管理について詳しくは、以下のページをご覧ください。

  • クラウドの Orchestrator の場合 - 公式ドキュメントをご覧ください。
  • オンプレミスの Orchestrator の場合 - 公式ドキュメントをご覧ください。

Jenkins プラグインのトラブルシューティング

インストールまたはアップグレードに関する問題が発生した場合は、以下のトラブルシューティングをお試しください。

未承認のエラー

説明: 未承認のエラーです。

解決策:

• 基本認証を使用する場合: Web ログインのユーザー名とパスワードの組み合わせが正しいことを確認してください。

  フェデレーション認証が有効化されている場合は、タスクのユーザー名を「DOMAIN\user」と記述してください。

• トークン認証を使用する場合:

  • API アクセス パネルからトークンを取り消し、新しいトークンを生成します。
  • キーを生成したユーザーが Orchestrator にアクセスでき、Orchestrator インスタンス上にユーザー アカウントを持っていることを確認します。
• オンプレミスの Orchestrator に対する認証を行う場合: Orchestrator の証明書が有効であること、および自己署名証明書を使用している場合は、ジョブを実行するマシンが Orchestrator の証明書を信頼していることを確認してください。Orchestrator に使用する証明書が有効でないことが原因で、このエラーが発生することがあります。これは、CN に誤りがある、またはその他の検証の問題があることを意味する可能性があります。

Forbidden エラー

解決策: ユーザーに、その操作を実行する権限がありません。フォルダーの読み取り、パッケージのアップロード、プロセスの作成と更新、テスト セットとテスト ケースの読み取り、バックグラウンド タスクの読み取り、テスト セットの作成と実行の権限がユーザーに付与されていることを確認します。

フォルダー/ロボット グループが見つからない

手順: CI/CD プラグインで使用される認証済みユーザーに、Folders.View 権限と BackgroundTask.View 権限 (v20.4 の場合のみ) があることを確認してください。

パッケージが既に存在する (競合)

解決策: デプロイしようとしているパッケージの同じバージョンが存在しないことを確認します。存在する場合は、自動パッケージ バージョン管理を使用して、デプロイごとに新しいバージョンに上がるようにすることを検討してください。

コマンドの実行に失敗した (一般的なエラー)

解決策: Jenkins ワークスペースがディスク上の場所の中 (C:\Windows or C:\Program Files など) に存在し、ユーザーがその場所へのアクセス権を持っていない場合は、そのユーザーがアクセスできるパスにワークスペースが配置されているようにします。

Jenkins がアルファベット以外の文字を含むパスを処理できない

解決策: UiPath プラグインを呼び出すときに、Jenkins が非標準のエンコードされた文字を正しく渡すことができません。不明な文字は ??? で置換されます。

Jenkins がサーバーとエージェントの両方のホスト マシンにどのようにデプロイされているかによって解決策が異なりますが、Java のオプションで file.encoding を UTF-8 に設定する必要があります。

Windows

Windows 上でサービスとして Jenkins を実行している場合: サービス構成ファイルでタグに引数を追加します。スクリプト例は以下のとおりです。

<arguments>-Xrs -Xmx512m -Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle -Dfile.encoding=UTF-8 -jar "%BASE%\)\)jenkins.war" --httpPort=8080 --webroot="%BASE%\)\)war"</arguments>

Docker 内で Jenkins を実行している場合: 次のスクリプト例のように --env JAVA_OPTS="..." を介して JAVA_OPTS をコンテナーに渡します。

docker run --name myjenkins -p 8080:8080 -p 50000:50000 --env JAVA_OPTS=-Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle -Dfile.encoding=UTF-8 jenkins/jenkins:lts

Jenkins を Tomcat 内で実行する場合: 環境変数 CATALINA_OPTS を使用します。スクリプト例は以下のとおりです。

export CATALINA_OPTS="-DJENKINS_HOME=/path/to/jenkins_home/ -Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle -Dfile.encoding=UTF-8 -Xmx512m"

Linux

Debian または Ubuntu ベースの Linux のディストリビューションで実行している場合: 構成ファイルで引数 JAVA_ARGS を検索し、ファイル エンコードを追加します。スクリプト例は以下のとおりです。

JAVA_ARGS="-Dfile.encoding=UTF-8 -Xmx512m"

RedHat の Linux ベースのディストリビューションで実行する場合: 構成ファイルで引数 JENKINS_JAVA_OPTIONS を検索し、ファイル エンコードを追加します。スクリプト例は以下のとおりです。

JENKINS_JAVA_OPTIONS="-Dfile.encoding=UTF-8 -Xmx512m"