Skip to content

Commit

Permalink
feat(3106): Add job annotations to customizable field for pipeline te…
Browse files Browse the repository at this point in the history
…mplate (#618)
  • Loading branch information
y-oksaku authored Nov 26, 2024
1 parent b7fcea1 commit bc42c69
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/ja/user-guide/templates/pipeline-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ Example `screwdriver.yaml`:
```yaml
template: nodejs/[email protected]
shared:
environment:
FOO: bar
environment:
FOO: bar
```

バージョンは[semver](https://semver.org/)互換です。例えば上記のテンプレートでは`nodejs/test@1`や`nodejs/[email protected]`と指定できます。
Expand All @@ -107,7 +107,7 @@ shared がパイプラインテンプレート、またはテンプレートを
#### Jobs
パイプラインテンプレートを使用時に、`jobs`設定内でいくつかのカスタマイズが可能です。

パイプラインテンプレートに*既に存在する*名前のユーザー定義ジョブについては、`image`、`settings`、`environment`、`requires`のフィールドのみカスタマイズが可能です。
パイプラインテンプレートに*既に存在する*名前のユーザー定義ジョブについては、`image`、`settings`、`environment`、`annotations`、`requires`のフィールドのみカスタマイズが可能です。

パイプラインテンプレート内に*存在しない*名前のユーザー定義ジョブについては、すべてのフィールドでカスタマイズが可能です。

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/templates/pipeline-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,15 +95,15 @@ If no template version is specified, the most recently published will be used. T
The most reliable way to avoid unexpected template changes is to refer to a specific version of the template. For instance, `nodejs/[email protected]` is an immutable reference to a particular list of steps. Using a reference such as `nodejs/[email protected]` means that a job will automatically use `nodejs/[email protected]` when it becomes available, but that comes with risk of an unexpected change in behavior.

### Customization
Many fields can be customized when using Pipeline Template: shared, jobs, cache, subscribe, parameters, annotations, and stages.
Many fields can be customized when using Pipeline Template: shared, jobs, cache, subscribe, parameters, annotations, and stages.

#### Shared
When `shared` is set in either the Pipeline Template or user yaml, priority will be (in decreasing order): user job > user shared > pipeline template job > pipeline template shared

#### Jobs
Some customization can be done within the `jobs` configuration when using a Pipeline Template.

For user-defined jobs with names that *already exist* in the pipeline template, customization is limited to a set of certain fields: `image`, `settings`, `environment`, and `requires`.
For user-defined jobs with names that *already exist* in the pipeline template, customization is limited to a set of certain fields: `image`, `settings`, `environment`, `annotations`, and `requires`.

For user-defined jobs with names that *do not already exist* in the pipeline template, all jobs fields are allowed.

Expand Down

0 comments on commit bc42c69

Please sign in to comment.