「みんなの翻訳」は、世界中の文書をみんなで協力して翻訳するサイトです。

みんなの翻訳ロゴ
ブクタブ
翻訳サイト

カテゴリ一覧

このサイトについて 新規登録はこちら お試し翻訳

一覧

2017/07/28

メンテナンス終了のお知らせ

2017/7/25-2017/7/28に実施したメンテナンスは、2017/7/28/14:20に終了いたしました。 ご協力をいただき、ありが…

List

Hnoss

English⇒Japanese

acai

English⇒Japanese

jhoo0509

English⇒Japanese

yoko

English⇒Japanese

ホーム > 翻訳記事

翻訳記事

【GitLab 公式 を訳してみた】job artifacts の概要

 GitLab Documentation > User documentation > Projects > job artigacts の概要

 注:

  • この機能は、GitLab 8.2 並びに GitLab Runner 0.7.0以降から導入されたものです。GitLab Runnerの一機能で、GitLabにアップロードしたものを、GitLab UIからシングルアーカイブ(tar.gz)としてダウンロードできるようにします。 
  • GitLab 8.4 並びに GitLab Runner 1.0以降からは、アーティファクトのアーカイブ形式がZIPファイルに変更になりました。これにてそれぞれのファイルをダウンロードすることで、コンテンツを閲覧することが可能になりました。
  • GitLab 8.17以降からは、「builds」が「jobs」に改称されました。
  • GitLab Runner 1.0以上から GitLabに送られた新しいアーティファクトにのみ、アーティファクツ・ブラウザが適用されることになる予定です。既にアップロードされている古いアーティファクトにおいては、閲覧できません。
  • このページは、job artifactsの簡単な使用説明書です。所有権の管理などについては、administration/job_artifactsをご覧ください。


 アーティファクトは、jobが完全に成功したあとに作成される一連のファイルやディレクトリのことです。この機能はGitLabをインストールした時点で、デフォルトで使われるようになっています。

 

  .gitlab-ci.yml」でアーティファクトを定義する
 
.gitlab-ci.yml 設定メニューからお越しの方へ。『管理者にアーティファクトを復活させる…』と訳してしまいましたが、誤訳です。正確には『有効期限を変更する』というニュアンスでした。)

  アーティファクトは「.gitlab-ci.yml」で詳細を指定できます。
 以下は簡単な設定例です。

======================
pdf:
 script: xelatex mycv.tex
 artifacts:
  paths:
  - mycv.pdf
  expire_in: 1 week
======================

  「pdf」と名付けられたこのjobには、xelatexコマンドを呼び出して、latexソースファイル(mycv.tex)からPDFファイルをビルドする働きがあります。「artifacts」の下には、「paths」というキーワードがあり、どこに生成物を配置するかを定義します。ここに定義するファイルやディレクトリには、ビルドの最中にクローンされるようなレポジトリに関連しているところを選びましょう。
 アップロードしたアーティファクトは、「expire_in definition」というパラメータでGitLabでの保持期間を定義できます。ここでは1 weekとされています。定義した期間を過ぎると、アーティファクトが有効期限切れとして扱われ、ウェブインターフェイスから閲覧できないようになります。この項目を定義しなかった場合は、アーティファクトが無期限に公開され続けます。
 

  「artifacts」の具体的な使い方は、artifacts reference in .gitlab-ci.yml をご覧ください。

 

  アーティファクトの閲覧

 注:GitLab 9.2では、PDF、画像、ビデオ、その他フォーマットがjobアーティファクトの閲覧形式として指定できます。閲覧に際にファイルのダウンロードは必要ありません。

 注:GitLab 10.1では、公開プロジェクトのHTMLファイルが閲覧できるようになりました。閲覧の際にファイルのダウンロードは必要ないほか、プレビューは新しいタブで展開されます。閲覧の際にGitLab Pages機能を利用します。

  job 終了後、job詳細ページに移動すると、3つのボタンが出現しているはずです。そこから、アーティファクトアーカイブをダウンロードしたり、コンテンツを閲覧したりできます。
 「Keep」というボタンもありますが、これはアーティファクトの掲載期間を変更するときに使います。
 (写真1)job アーティファクト閲覧ボタン

  アーカイブブラウザでは、アーティファクトの名前とファイルのサイズが表示されています。閲覧したいアーティファクトがディレクトリに入っていたとしても、その中から閲覧することができますので、閲覧のためにわざわざファイルをどこかに移送させる必要はありません。

  (写真2)では、ブラウジング画面の一例を表示しています。写真には、1つのディレクトリ内に、2つのファイルがあります。そのうち片方だけがHTMLファイルになっており、GitLab Pages機能が扱えるサーバーであれば、ビューアが(新しいタブで)表示されます。
 (写真2)job aritifacts ブラウザ

 

  アーティファクトのダウンロード

  アーカイブをある程度まとまった範囲でダウンロードする必要がある時に、GitLabの内部に配置されたボタンが役に立つことでしょう。

  1.「pipelines」ページに移動しましょう。それぞれのjobアーティファクトの右端にダウンロード用のアイコンが用意されています。
 (写真3)Pipelines ページの Jobアーティファクトたち

  2.それから「Jobs」ページに移動しましょう。ここでも右端にダウンロード用のアイコンが配置されています。
 (写真4)「Jobs」ページの Jobアーティファクトたち

  3.特定のjobのアーティファクトをダウンロードするには、アーティファクトブラウザのボタンを使うとよいでしょう。
 (写真5)job アーティファクト閲覧ボタン

  4.最後に、アーカイブを閲覧しているときに、右上の角にダウンロードボタンがあることをお忘れなく。
 (写真6)job aritifacts ブラウザ

 

  最新のアーティファクトをダウンロードする

  最新版のアーティファクトなら、スクリプトからよく知っているURLでダウンロードすることができます。

 注:最新のアーティファクトとは、特定のrefに対して、最新のパイプラインでしたjobが成功したときにのみ発生する生成物のことです。他のパイプラインで作成されたアーティファクトについては、そこに直接アクセスするURLを指定しなくてはいけません。

  アーティファクトのダウンロードに使われるURLは、次のように表記します。

============================================
https://example.com/<namespace>/<project>/-/jobs/artifacts/<ref>/download?job=<job_name>
============================================

  アーティファクトから特定のファイルだけを抜き出してダウンロードしたい場合は、次のようなURLを指定してください。

============================================
https://example.com/<namespace>/<project>/-/jobs/artifacts/<ref>/raw/<path_to_file>?job=<job_name>
============================================


  たとえば、「gitlab-org」という名前空間で管理されている、「gitlab-ce」プロジェクトの「master」ブランチ、「coverage」というjobのアーティファクトを取得する際には、次のURLを入力します。

============================================
https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/artifacts/master/download?job=coverage
============================================

  同じアーティファクトから、「coverage/index.html」というファイルをダウンロードするには、次のURLを入力します。

============================================
https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/artifacts/master/raw/coverage/index.html?job=coverage
============================================

  最新のアーティファクトを閲覧するためのURLは、

============================================
https://example.com/<namespace>/<project>/-/jobs/artifacts/<ref>/browse?job=<job_name>
============================================

  先ほどのアーティファクトを閲覧するには、

============================================
https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/artifacts/master/browse?job=coverage
============================================

  最新版につきましては、UIの複数個所からダウンロードすることができます。ダウンロードボタンは、次の場所に出現します。

  • メイン「project」ページ
  • 「branches」ページ
  • 「tags」ページ

 最後に実施されたjobが失敗して、アーティファクトのアップロードが叶わなかった場合は、その情報がUIに表示されます。
 (写真7)最新アーティファクト ボタン

 

  アーティファクトの消去

 警告:この操作は修復が不能なため、データ消失などの事後につながりかねません。ご使用の際には、十分ご注意ください。

  この操作を行うには、ユーザーがそのプロジェクトに最低でも開発者権限を持っていなくてはなりません。
 ユーザーインターフェイスから、任意のjobを消去すると、そこのアーティファクトとjobのトレースが消去されます。

  1. 「job」ページに移動する
  2. jobのトレースの右上にゴミ箱アイコンがあります。そこをクリック。
  3. 削除されていることを確認してください。
 Edit this page
PDF
更新日:2018-03-23 21:54:23 Hnoss 0  del.icio.usに追加   はてなブックマークに追加   twitterに投稿   facebookでshare
[ 原文 ] https://docs.gitlab.com/ee/user/project/pipelines/job_artifacts.html 原文ページプロジェクト並びにドキュメントファイルは、MIT Licenseのもと公開されています。(URL:https://gitlab.com/gitlab-com/gitlab-docs/blob/master/LICENSE) この記事の文章は、訳者の判断によりCreative Commons BY (version 3.0) を適用するものとします。
翻訳者ページをみる

この記事の翻訳者

Hnoss さんの翻訳記事

[翻訳]GitLabハンドブック>エンジニアリング

現在の位置: チームハンドブック 目次 >エンジニアリング   連絡方法 Public Issue Tracker (GitLab CEの場合) ; 不特定多数に公開しては問題が発生するような一部の題材に…2018-05-26 00:10:26

[翻訳]GitLabハンドブック>UX部門

現在の位置: チームハンドブック 目次 >UX部門   UX ガイド  GitLabの見た目は、 UXガイド を基準に構成されている。このガイドが、わが社におけるデザインの原論、表現法、…2018-05-26 00:09:10

【GitLab 公式 を訳してみた】GitLab UX ガイド

GitLab Documentation > GitLab development guides >GitLab UX ガイド  現在、UX documentationの内容を、 design.gitlab.com projectに移行しております。この説明書の更新…2018-05-26 00:06:03

[翻訳]GitLabハンドブック>インフラストラクチャ>Gitaly チーム

現在の位置: チームハンドブック 目次 > インフラストラクチャ >Gitaly チーム   関連リンク Gitaly専用 パブリックイシュー トラッカー チャットチャンネル ;チャンネル…2018-05-24 18:53:54