gitlabダウンロード - gitlabソースコードのダウンロード

gitlab

その他のソースコード

v13.2.1

ダウンロード

@semantic-release/gitlab

GitLab リリースを公開するためのsemantic-releaseプラグイン。

ステップ	説明
`verifyConditions`	認証の存在と有効性を確認します (環境変数によって設定されます)。
`publish`	GitLab リリースを公開します。
`success`	リリースによって解決された各 GitLab 問題またはマージリクエストにコメントを追加します。
`fail`	リリースの失敗の原因となったエラーに関する情報を含む GitLab Issue を開くか更新します。

インストール

$ npm install @semantic-release/gitlab -D

使用法

プラグインは、 semantic-release構成ファイルで構成できます。

{
  "branches" : [ " main " ],
  "plugins" : [
    " @semantic-release/commit-analyzer " ,
    " @semantic-release/release-notes-generator " ,
    [
      " @semantic-release/gitlab " ,
      {
        "gitlabUrl" : " https://custom.gitlab.com " ,
        "assets" : [
          { "path" : " dist/asset.min.css " , "label" : " CSS distribution " },
          { "path" : " dist/asset.min.js " , "label" : " JS distribution " , "target" : " generic_package " },
          { "path" : " dist/asset.min.js " , "label" : " v${nextRelease.version}.js " },
          { "url" : " https://gitlab.com/gitlab-org/gitlab/-/blob/master/README.md " }
        ]
      }
    ]
  ]
}

この例では、GitLab リリースはhttps://custom.gitlab.comインスタンスに公開されます。

構成

GitLab認証

GitLab 認証構成は必須であり、環境変数を介して設定できます。

開発者(以上) ロールとapiスコープを使用して、プロジェクトアクセストークン、グループアクセストークン、または個人用アクセストークンを作成し、 GL_TOKEN環境変数を介して CI 環境で使用できるようにします。 GL_TOKENリモート Git リポジトリ認証として使用している場合は、 write_repositoryスコープも必要です。

注: dryRunで実行する場合、 read_repositoryスコープのみが必要です。

環境変数

変数	説明
`GL_TOKEN`または`GITLAB_TOKEN`	必須。 GitLab での認証に使用されるトークン。
`GL_URL`または`GITLAB_URL`	GitLab エンドポイント。
`GL_PREFIX`または`GITLAB_PREFIX`	GitLab API プレフィックス。
`HTTP_PROXY`または`HTTPS_PROXY`	使用する HTTP または HTTPS プロキシ。
`NO_PROXY`	プロキシを無視する必要があるパターン。詳細は以下をご覧ください。

プロキシ構成

このプラグインは、プロキシサーバーを介したリクエストの受け渡しをサポートします。

HTTPS_PROXY環境変数を使用してプロキシサーバーを構成できます: HTTPS_PROXY=http://proxyurl.com:8080

プロキシサーバーで認証が必要な場合は、URL にユーザー名とパスワードを埋め込みます: HTTPS_PROXY=http://user:[email protected]:8080

GitLab インスタンスがプレーン HTTP 経由で公開されている場合 (推奨されません!)、代わりにHTTP_PROXY使用してください。

一部のホストに対してプロキシをバイパスする必要がある場合は、 NO_PROXY環境変数を構成します: NO_PROXY=*.host.com, host.com

オプション

オプション	説明	デフォルト
`gitlabUrl`	GitLab エンドポイント。	`GL_URL`または`GITLAB_URL`環境変数、または GitLab CI/CD または`https://gitlab.com`で実行している場合は CI が提供する環境変数。
`gitlabApiPathPrefix`	GitLab API プレフィックス。	`GL_PREFIX`または`GITLAB_PREFIX`環境変数、または GitLab CI/CD または`/api/v4`で実行している場合は CI が提供する環境変数。
`assets`	リリースにアップロードするファイルの配列。資産を参照してください。	-
`milestones`	リリースに関連付けるマイルストーンタイトルの配列。「GitLab リリース API」を参照してください。	-
`successComment`	リリースによって解決された各問題およびマージリクエストに追加するコメント。 success コメントを参照してください。	?この問題はバージョン ${nextRelease.version} で解決されましたか?nnこのリリースは GitLab リリースで利用可能です
`successCommentCondition`	これを、いつ問題にコメントしたりリクエストをマージしたりするかという条件として使用します。 successCommentCondition を参照してください。	-
`failComment`	リリースが失敗したときに作成される問題の内容。「failComment」を参照してください。	セマンティックリリースのドキュメントとサポートへのリンク、リリースの失敗の原因となったエラーのリストを含むフレンドリーなメッセージ。
`failTitle`	リリースが失敗したときに作成される問題のタイトル。	`The automated release is failing`
`failCommentCondition`	これを、失敗の場合にコメントしたり問題を作成したりするときの条件として使用します。「failCommentCondition」を参照してください。	-
`labels`	リリースが失敗したときに作成される問題に追加するラベル。ラベルを追加しない場合は`false`に設定します。ラベルは、公式ドキュメントに記載されているように、カンマで区切る必要があります (例: `"semantic-release,bot"` 。	`semantic-release`
`assignee`	リリースが失敗したときに作成される問題に追加する担当者。	-

資産

グロブ、またはグロブのArray 、および次のプロパティを持つObjectを指定できます。

財産	説明	デフォルト
`path`	`url`が設定されていない場合は必須です。アップロードするファイルを識別するグロブ。 Lodash テンプレートをサポートします。	-
`url`	`path`を設定する代わりに、リリースへのリンク (コンテナイメージへの URL など) を追加する機能が提供されます。 Lodash テンプレートをサポートします。	-
`label`	GitLab リリースに表示されるファイルの簡単な説明。 `path`複数のファイルに一致する場合は無視されます。 Lodash テンプレートをサポートします。	`path`から抽出されたファイル名。
`type`	GitLab リリースに表示されるアセットのタイプ。 `runbook` 、 `package` 、 `image` `other`を使用できます (リリース資産に関する公式ドキュメントを参照)。 Lodash テンプレートをサポートします。	`other`
`filepath`	アセットを指すパーマリンクを作成するためのファイルパス (GitLab 12.9 以降が必要、パーマリンクに関する公式ドキュメントを参照)。 `path`複数のファイルに一致する場合は無視されます。 Lodash テンプレートをサポートします。	-
`target`	ファイルのアップロード先を制御します。ファイルをプロジェクトアップロードとして保存する場合は`project_upload`に設定し、ファイルを汎用パッケージとして保存する場合は`generic_package`に設定できます。	`project_upload`
`status`	これは、 `target`が`generic_package`に設定されている場合にのみ適用されます。一般的なパッケージのステータス。 `default`または`hidden`することができます (汎用パッケージに関する公式ドキュメントを参照してください)。	`default`

assets Array内の各エントリは個別にグロブされます。グロブはString ( "dist/**/*.js"または"dist/mylib.js" )、またはまとめてグロブされるStringのArray ( ["dist/**", "!**/*.css"] )。

ディレクトリが設定されている場合は、このディレクトリの下にあるすべてのファイルとその子が含まれます。

注: ファイルのassetsに一致がある場合、 .gitignoreにも一致がある場合でも、そのファイルは含まれます。

アセットの例

'dist/*.js' : distディレクトリ内のすべてのjsファイルを含めますが、そのサブディレクトリには含めません。

[['dist', '!**/*.css']] : distディレクトリとそのサブディレクトリ内の、 cssファイルを除くすべてのファイルを含めます。

[{path: 'dist/MyLibrary.js', label: 'MyLibrary JS distribution'}, {path: 'dist/MyLibrary.css', label: 'MyLibrary CSS distribution'}] : dist/MyLibrary.jsとdist/MyLibrary.cssファイルに、GitLab リリースのMyLibrary JS distributionとMyLibrary CSS distributionのラベルを付けます。

[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}] : include distディレクトリとそのサブディレクトリにあるすべてのjsおよびcssファイル (縮小バージョンを除く)、およびbuild/MyLibrary.zipファイルを追加し、GitLab でMyLibraryラベルを付けます。リリース。

成功コメント

問題コメントのメッセージは Lodash テンプレートを使用して生成されます。次の変数が使用可能です。

パラメータ	説明
`branch`	`name` 、 `type` 、 `channel` 、 `range` 、およびリリースが行われるブランチの`prerelease`プロパティを持つ`Object` 。
`lastRelease`	前回のリリースの`version` 、 `channel` 、 `gitTag` 、および`gitHead`を含む`Object` 。
`nextRelease`	`version` 、 `channel` 、 `gitTag` 、 `gitHead`および実行中のリリースの`notes`を含む`Object` 。
`commits`	`hash` 、 `subject` 、 `body` `message` 、 `author`を含むコミット`Object`の`Array` 。
`releases`	公開された各リリースの release `Object`を含む`Array` 。 `name`や`url`などのオプションのリリースデータも含まれます。
`issue`	コメントが投稿される GitLab API Issue オブジェクト、またはマージリクエストにコメントする場合は`false` 。
`mergeRequest`	コメントが投稿される GitLab API Merge Request オブジェクト、または問題にコメントする場合は`false` 。

成功コメント条件

成功コメント条件は Lodash テンプレートを使用して生成されます。次の変数が使用可能です。

パラメータ	説明
`branch`	`name` 、 `type` 、 `channel` 、 `range` 、およびリリースが行われるブランチの`prerelease`プロパティを持つ`Object` 。
`lastRelease`	前回のリリースの`version` 、 `channel` 、 `gitTag` 、および`gitHead`を含む`Object` 。
`nextRelease`	`version` 、 `channel` 、 `gitTag` 、 `gitHead`および実行中のリリースの`notes`を含む`Object` 。
`commits`	`hash` 、 `subject` 、 `body` `message` 、 `author`を含むコミット`Object`の`Array` 。
`releases`	公開された各リリースの release `Object`を含む`Array` 。 `name`や`url`などのオプションのリリースデータも含まれます。
`issue`	コメントが投稿される GitLab API Issue オブジェクト。
`mergeRequest`	コメントが投稿される GitLab API マージリクエストオブジェクト。

successCommentCondition の例

コメントをまったく作成しない: falseに設定するか、テンプレート化: "<% return false; %>"
問題のみにコメントするには: "<% return issue %>"
マージリクエストのみにコメントするには: "<% return mergeRequest %>"
ラベルを使用して問題をフィルタリングできます: "<% return issue.labels?.includes('semantic-release-relevant') %>"

フィルターに使用できるプロパティについては、GitLab API Merge Request オブジェクトまたは GitLab API Issue オブジェクトを確認してください。

失敗コメント

課題内容のメッセージは Lodash テンプレートを使用して生成されます。次の変数が使用可能です。

パラメータ	説明
`branch`	リリースが失敗したブランチ。
`errors`	SemanticReleaseError の`Array` 。各エラーには、 `message` 、 `code` 、 `pluginName` 、および`details`プロパティがあります。 `pluginName`エラーをスローしたプラグインのパッケージ名が含まれます。 `details`マークダウン形式でフォーマットされたエラーに関する情報が含まれます。

失敗コメントの例

This release from branch ${branch.name} had failed due to the following errors:n- ${errors.map(err => err.message).join('\n- ')} failComment生成されます。コメント：

ブランチマスターからのこのリリースは、次のエラーにより失敗しました。
エラーメッセージ1
エラーメッセージ2

失敗コメント条件

失敗コメント条件は Lodash テンプレートを使用して生成されます。次の変数が使用可能です。

パラメータ	説明
`branch`	`name` 、 `type` 、 `channel` 、 `range` 、およびリリースが行われるブランチの`prerelease`プロパティを持つ`Object` 。
`lastRelease`	前回のリリースの`version` 、 `channel` 、 `gitTag` 、および`gitHead`を含む`Object` 。
`nextRelease`	`version` 、 `channel` 、 `gitTag` 、 `gitHead`および実行中のリリースの`notes`を含む`Object` 。
`commits`	`hash` 、 `subject` 、 `body` `message` 、 `author`を含むコミット`Object`の`Array` 。
`releases`	公開された各リリースの release `Object`を含む`Array` 。 `name`や`url`などのオプションのリリースデータも含まれます。
`issue`	コメントが投稿される GitLab API Issue オブジェクト。未解決の問題が存在する場合にのみ使用できます。

失敗コメント条件の例

コメントをまったく作成しない: falseに設定するか、テンプレート化: "<% return false; %>"
メインブランチのみにコメントするには: "<% return branch.name === 'main' %>"
ラベルを使用して問題をフィルタリングできます。つまり、問題にwipのラベルが付いている場合はコメントしないようにできます: "<% return !issue.labels?.includes('wip') %>"