Skip to content

Commit 1558588

Browse files
authored
Merge pull request github#17305 from github/repo-sync
repo sync
2 parents fdb49b3 + 9aef339 commit 1558588

File tree

112 files changed

+1645
-1146
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+1645
-1146
lines changed

content/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,11 @@ Just add a hyphen on either the left, right, or both sides to indicate that ther
336336

337337
## Links and image paths
338338

339-
Local links must start with a product ID (like `/actions` or `/admin`), and image paths must start with `/assets`. The links to Markdown pages undergo some transformations on the server side to match the current page's language and version. The handling for these transformations lives in [`lib/render-content/plugins/rewrite-local-links`](lib/render-content/plugins/rewrite-local-links.js).
339+
Links to docs in the `docs-internal` repository must start with a product ID (like `/actions` or `/admin`) and contain the entire filepath, but not the file extension. For example, `/actions/creating-actions/about-custom-actions`.
340+
341+
Image paths must start with `/assets` and contain the entire filepath including the file extension. For example, `/assets/images/help/settings/settings-account-delete.png`.
342+
343+
The links to Markdown pages undergo some transformations on the server side to match the current page's language and version. The handling for these transformations lives in [`lib/render-content/plugins/rewrite-local-links`](lib/render-content/plugins/rewrite-local-links.js).
340344

341345
For example, if you include the following link in a content file:
342346

@@ -364,6 +368,12 @@ Sometimes you want to link to a Dotcom-only article in Enterprise content and yo
364368

365369
Sometimes the canonical home of content moves outside the docs site. None of the links included in [`lib/redirects/external-sites.json`](/lib/redirects/external-sites.json) get rewritten. See [`contributing/redirects.md`](/contributing/redirects.md) for more info about this type of redirect.
366370

371+
### Legacy filepaths and redirects for links
372+
373+
Our docs contain links that use legacy filepaths such as `/article/article-name` or `/github/article-name`. Our docs also contain links that refer to articles by past names. Both of these link types function properly because of redirects, but they are bugs.
374+
375+
When you add a link to an article, use the current filepath and article name.
376+
367377
### Index pages
368378

369379
Index pages are the Table of Contents files for the docs site. Every product, category, and map topic subdirectory has an `index.md` that serves as the landing page. Each `index.md` must contain a `children` frontmatter property with a list of relative links to the child pages of the product, category, or map topic.

contributing/content-style-guide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,11 @@ For plain text, use linebreaks to separate paragraphs in the source (two consecu
230230

231231
## Links
232232

233-
Introduce links consistently using a standard format that clearly indicates where we’re linking: "For more information, see X [or "Page/article title"] in the X documentation." Do not include quotation marks within a hyperlink.
233+
Introduce links consistently using a standard format that clearly indicates where we’re linking.
234+
For links to other articles in the GitHub docs: `For more information, see "[Page or article title]()."`
235+
For links to another section in the same article: `For more information, see "[Header text]()."`
236+
For links to external documentation: `For more information, see [Page or article title]() in the X documentation.`
237+
Do not include quotation marks within a hyperlink.
234238

235239
Links should be meaningful and provide high value to the user’s journey - link out carefully. Move links that are helpful but not necessary to an article’s further reading section. Do not repeat the same link more than once in the same article or under the same H2 header.
236240

translations/ja-JP/content/actions/creating-actions/creating-a-composite-action.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Before you begin, you'll create a repository on {% ifversion ghae %}{% data vari
8282
- run: echo Hello ${{ inputs.who-to-greet }}.
8383
shell: bash
8484
- id: random-number-generator
85-
run: echo "::set-output name=random-id::$(echo $RANDOM)"
85+
run: echo "::set-output name=random-number::$(echo $RANDOM)"
8686
shell: bash
8787
- run: echo "${{ github.action_path }}" >> $GITHUB_PATH
8888
shell: bash

translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md

Lines changed: 5 additions & 167 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,7 @@ You can configure a {% data variables.product.prodname_actions %} _workflow_ to
5050

5151
### ワークフロー
5252

53-
A workflow is a configurable automated process that will run one or more jobs. Workflows are defined by a YAML file checked in to your repository and will run when triggered by an event in your repository, or they can be triggered manually, or at a defined schedule.
54-
55-
You can have multiple workflows in a repository, each of which can perform a different set of steps. For example, you can have one workflow to build and test pull requests, another workflow to deploy your application every time a release is created, and still another workflow that adds a label every time someone opens a new issue.
53+
{% data reusables.actions.about-workflows-long %}
5654

5755
{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}You can reference a workflow within another workflow, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."{% endif %}
5856

@@ -86,168 +84,7 @@ You can write your own actions, or you can find actions to use in your workflows
8684

8785
{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% ifversion ghes or ghae %} You must host your own runners for {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[Hosting your own runners](/actions/hosting-your-own-runners)."
8886

89-
## サンプルワークフローを作成する
90-
91-
{% data variables.product.prodname_actions %} uses YAML syntax to define the workflow. Each workflow is stored as a separate YAML file in your code repository, in a directory called `.github/workflows`.
92-
93-
コードがプッシュされるたびに一連のコマンドを自動的にトリガーするサンプルワークフローをリポジトリに作成できます。 このワークフローでは、{% data variables.product.prodname_actions %} がプッシュされたコードをチェックアウトし、ソフトウェアの依存関係をインストールして、`bats-v` を実行します。
94-
95-
1. リポジトリに、ワークフローファイルを保存するための `.github/workflows/` ディレクトリを作成します。
96-
1. `.github/workflows/` ディレクトリに、`learn-github-actions.yml` という名前の新しいファイルを作成し、次のコードを追加します。
97-
98-
```yaml
99-
name: learn-github-actions
100-
on: [push]
101-
jobs:
102-
check-bats-version:
103-
runs-on: ubuntu-latest
104-
steps:
105-
- uses: {% data reusables.actions.action-checkout %}
106-
- uses: {% data reusables.actions.action-setup-node %}
107-
with:
108-
node-version: '14'
109-
- run: npm install -g bats
110-
- run: bats -v
111-
```
112-
1. これらの変更をコミットして、{% data variables.product.prodname_dotcom %} リポジトリにプッシュします。
113-
114-
これで、新しい {% data variables.product.prodname_actions %} ワークフローファイルがリポジトリにインストールされ、別のユーザがリポジトリに変更をプッシュするたびに自動的に実行されます。 For details about a workflow's execution history, see "[Viewing the workflow's activity](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-workflows-activity)."
115-
116-
## ワークフローファイルを理解する
117-
118-
YAML 構文を使用してワークフローファイルを作成する方法を理解しやすくするために、このセクションでは、導入例の各行について説明します。
119-
120-
<table>
121-
<tr>
122-
<td>
123-
124-
```yaml
125-
name: learn-github-actions
126-
```
127-
</td>
128-
<td>
129-
<em>オプション</em> - {% data variables.product.prodname_dotcom %} リポジトリの [Actions] タブに表示されるワークフローの名前。
130-
</td>
131-
</tr>
132-
<tr>
133-
<td>
134-
135-
```yaml
136-
on: [push]
137-
```
138-
</td>
139-
<td>
140-
Specifies the trigger for this workflow. This example uses the <code>push</code> event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see <a href="https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore">"Workflow syntax for {% data variables.product.prodname_actions %}."</a>
141-
</td>
142-
</tr>
143-
<tr>
144-
<td>
145-
146-
```yaml
147-
jobs:
148-
```
149-
</td>
150-
<td>
151-
Groups together all the jobs that run in the <code>learn-github-actions</code> workflow.
152-
</td>
153-
</tr>
154-
<tr>
155-
<td>
156-
157-
```yaml
158-
check-bats-version:
159-
```
160-
</td>
161-
<td>
162-
Defines a job named <code>check-bats-version</code>. The child keys will define properties of the job.
163-
</td>
164-
</tr>
165-
<tr>
166-
<td>
167-
168-
```yaml
169-
runs-on: ubuntu-latest
170-
```
171-
</td>
172-
<td>
173-
Configures the job to run on the latest version of an Ubuntu Linux runner. これは、ジョブが GitHub によってホストされている新しい仮想マシンで実行されるということです。 他のランナーを使用した構文例については、「<a href="https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on">{% data variables.product.prodname_actions %} のワークフロー構文</a>」を参照してください。
174-
</td>
175-
</tr>
176-
<tr>
177-
<td>
178-
179-
```yaml
180-
steps:
181-
```
182-
</td>
183-
<td>
184-
<code>check-bats-version</code> ジョブで実行されるすべてのステップをグループ化します。 Each item nested under this section is a separate action or shell script.
185-
</td>
186-
</tr>
187-
<tr>
188-
<td>
189-
190-
```yaml
191-
- uses: {% data reusables.actions.action-checkout %}
192-
```
193-
</td>
194-
<td>
195-
The <code>uses</code> keyword specifies that this step will run <code>v3</code> of the <code>actions/checkout</code> action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will run against the repository's code.
196-
</td>
197-
</tr>
198-
<tr>
199-
<td>
200-
201-
```yaml
202-
- uses: {% data reusables.actions.action-setup-node %}
203-
with:
204-
node-version: '14'
205-
```
206-
</td>
207-
<td>
208-
This step uses the <code>{% data reusables.actions.action-setup-node %}</code> action to install the specified version of the Node.js (this example uses v14). This puts both the <code>node</code> and <code>npm</code> commands in your <code>PATH</code>.
209-
</td>
210-
</tr>
211-
<tr>
212-
<td>
213-
214-
```yaml
215-
- run: npm install -g bats
216-
```
217-
</td>
218-
<td>
219-
<code>run</code> キーワードは、ランナーでコマンドを実行するようにジョブに指示します。 この場合、<code>npm</code> を使用して <code>bats</code> ソフトウェアテストパッケージをインストールしています。
220-
</td>
221-
</tr>
222-
<tr>
223-
<td>
224-
225-
```yaml
226-
- run: bats -v
227-
```
228-
</td>
229-
<td>
230-
最後に、ソフトウェアバージョンを出力するパラメータを指定して <code>bats</code> コマンドを実行します。
231-
</td>
232-
</tr>
233-
</table>
234-
235-
### ワークフローファイルの視覚化
236-
237-
この図では、作成したワークフローファイルと、{% data variables.product.prodname_actions %} コンポーネントが階層にどのように整理されているかを確認できます。 Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. ワークフローのビルド済みアクションの詳細については、「[アクションの検索とカスタマイズ](/actions/learn-github-actions/finding-and-customizing-actions)」を参照してください。
238-
239-
![ワークフローの概要](/assets/images/help/images/overview-actions-event.png)
240-
241-
## Viewing the workflow's activity
242-
243-
Once your workflow has started running, you can see a visualization graph of the run's progress and view each step's activity on {% data variables.product.prodname_dotcom %}.
244-
245-
{% data reusables.repositories.navigate-to-repo %}
246-
1. リポジトリ名の下で**Actions(アクション)**をクリックしてください。 ![リポジトリに移動](/assets/images/help/images/learn-github-actions-repository.png)
247-
1. 左サイドバーで、表示するワークフローをクリックします。 ![ワークフロー結果のスクリーンショット](/assets/images/help/images/learn-github-actions-workflow.png)
248-
1. [Workflow runs] で、表示する実行の名前をクリックします。 ![ワークフロー実行のスクリーンショット](/assets/images/help/images/learn-github-actions-run.png)
249-
1. [**Jobs**] または視覚化グラフで、表示するジョブをクリックします。 ![ジョブを選択](/assets/images/help/images/overview-actions-result-navigate.png)
250-
1. 各ステップの結果を表示します。 ![ワークフロー実行の詳細のスクリーンショット](/assets/images/help/images/overview-actions-result-updated-2.png)
87+
{% data reusables.actions.workflow-basic-example-and-explanation %}
25188

25289
## 次のステップ
25390

@@ -263,7 +100,8 @@ To understand how billing works for {% data variables.product.prodname_actions %
263100

264101
{% data reusables.actions.contacting-support %}
265102

103+
{% ifversion ghec or ghes or ghae %}
266104
## 参考リンク
267105

268-
{% ifversion ghec or ghes or ghae %}
269-
- "[About {% data variables.product.prodname_actions %} for enterprises](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)"{% endif %}
106+
- "[About {% data variables.product.prodname_actions %} for enterprises](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)"
107+
{% endif %}

0 commit comments

Comments
 (0)