Skip to content

Commit

Permalink
docs: Japanese translation of metadata page (#133)
Browse files Browse the repository at this point in the history
* Translate metadata.md via GitLocalize

* fix metadata.md

* fix menu_ja

* delete old metadata.md

* fix metadata.md

* adjust space

* fix expression
  • Loading branch information
yuichi10 authored and tkyi committed Jan 9, 2018
1 parent 8c472f3 commit aa8dd3e
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 43 deletions.
4 changes: 2 additions & 2 deletions docs/_data/menu_ja.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
subcategories:
- title: "全体"
url: "/ja/user-guide/configuration/"
- title: "Metadata"
url: "/ja/user-guide/configuration/metadata"
- title: "Secrets"
url: "/ja/user-guide/configuration/secrets"
- title: "Metadata"
url: "/ja/user-guide/metadata"
- title: "環境変数"
url: "/ja/user-guide/environment-variables"
- title: "テンプレート"
Expand Down
41 changes: 0 additions & 41 deletions docs/ja/user-guide/configuration/metadata.md

This file was deleted.

65 changes: 65 additions & 0 deletions docs/ja/user-guide/metadata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
layout: main
title: Metadata
category: User Guide
menu: menu_ja
toc:
- title: Metadata
url: "#metadata"
- title: Metadataとは?
url: "#Metadataとは"
- title: Metadataの操作
url: "#Metadataの操作"
---

# Metadata

## Metadataとは?

Metadataは [ビルド](../../about/appendix/domain#build) に関する情報を保持する key/value ストアです。Metadataは [steps](../../about/appendix/domain#step) 内で組み込まれている [meta CLI](https://github.com/screwdriver-cd/meta-cli) を利用することで、全てのビルドで更新と取得が可能です。

## Metadataの操作

Screwdriver は meta store から情報を取得するためのシェルコマンド `meta get` と、meta store に情報を保存するためのシェルコマンド `meta set` を提供しています。

### 同一パイプライン

Screwdriverのビルドでは、同ビルドでセットされたMetadata、もしくは同パイプラインの以前のビルドでセットされたMetadataを取得することができます。

例: `build1` -> `build2` -> `build3`

`build2` のMetadataは、自身でセットしたMetadataと `build1` でセットしたMetadataを保持しています。

`build3` のMetadataは、 `build2` が持っていたMetadataを保持しています。 ( `build1` のMetadataも含む)

```bash
$ meta set example.coverage 99.95
$ meta get example.coverage
99.95
$ meta get example
{"coverage":99.95}
```

例:

```bash
$ meta set foo[2].bar[1] baz
$ meta get foo
[null,null,{"bar":[null,"baz"]}]
```

### 外部パイプライン

Screwdriverのビルドは外部トリガー元のジョブのMetadataにも `--external` フラグにトリガー元のジョブを指定することでアクセスすることができます。

例: `sd@123:publish` -> `build1` の時 `build1` のビルド内で:

```
$ meta get example --external sd@123:publish
{"coverage":99.95}
```

注意:

- `meta set` は外部パイプラインのジョブに対してはできません。
- もしフラグの値がトリガー元のジョブではなかった場合、 `meta get``null` を返します。

0 comments on commit aa8dd3e

Please sign in to comment.