Skip to content

Commit

Permalink
Merge branch 'main' into move-explorer-to-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahs authored Dec 8, 2020
2 parents a4f2444 + 91d3857 commit bdc9f69
Show file tree
Hide file tree
Showing 163 changed files with 1,653 additions and 452 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/help/images/workflow-graph-job.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/help/images/workflow-graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Diff not rendered.
Binary file modified assets/images/help/repository/view-run-billable-time.png
Binary file modified assets/images/help/settings/appearance-tab.png
Binary file modified assets/images/help/sponsors/edit-sponsorship-payment-button.png
Binary file modified assets/images/help/sponsors/manage-your-sponsorship-button.png
Binary file added assets/images/help/sponsors/sponsoring-tab.png
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,10 @@ jobs:
```
{% endraw %}
From your repository, click the **Actions** tab, and select the latest workflow run. You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run-updated.png)
{% else %}
![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run.png)
{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -261,9 +261,11 @@ jobs:
```
{% endraw %}
From your repository, click the **Actions** tab, and select the latest workflow run. You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png)
{% elsif currentVersion ver_gt "[email protected]" %}
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png)
{% else %}
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run.png)
Expand Down
4 changes: 4 additions & 0 deletions content/actions/guides/about-packaging-with-github-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ Creating a package at the end of a continuous integration workflow can help duri

Now, when reviewing a pull request, you'll be able to look at the workflow run and download the artifact that was produced.

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png)
{% else %}
![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png)
{% endif %}

This will let you run the code in the pull request on your machine, which can help with debugging or testing the pull request.

Expand Down
4 changes: 4 additions & 0 deletions content/actions/guides/building-and-testing-powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,11 @@ jobs:
* `run: Test-Path resultsfile.log` - Check whether a file called `resultsfile.log` is present in the repository's root directory.
* `Should -Be $true` - Uses Pester to define an expected result. If the result is unexpected, then {% data variables.product.prodname_actions %} flags this as a failed test. For example:

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test-updated.png)
{% else %}
![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test.png)
{% endif %}

* `Invoke-Pester Unit.Tests.ps1 -Passthru` - Uses Pester to execute tests defined in a file called `Unit.Tests.ps1`. For example, to perform the same test described above, the `Unit.Tests.ps1` will contain the following:
```
Expand Down
7 changes: 5 additions & 2 deletions content/actions/guides/storing-workflow-data-as-artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,6 @@ jobs:
path: output/test/code-coverage.html
```
![Image of workflow upload artifact workflow run](/assets/images/help/repository/upload-build-test-artifact.png)
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
### Configuring a custom artifact retention period
Expand Down Expand Up @@ -238,7 +236,12 @@ jobs:
echo The result is $value
```
The workflow run will archive any artifacts that it generated. For more information on downloading archived artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)."
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png)
{% else %}
![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png)
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ In this diagram, you can see the workflow file you just created and how the {% d
### Viewing the job's activity
Once your job has started running, you can view each step's activity on {% data variables.product.prodname_dotcom %}.
Once your job has started running, you can {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}.
{% data reusables.repositories.navigate-to-repo %}
1. Under your repository name, click **Actions**.
Expand All @@ -213,7 +213,14 @@ Once your job has started running, you can view each step's activity on {% data
![Screenshot of workflow results](/assets/images/help/images/learn-github-actions-workflow.png)
1. Under "Workflow runs", click the name of the run you want to see.
![Screenshot of workflow runs](/assets/images/help/images/learn-github-actions-run.png)
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
1. Under **Jobs** or in the visualization graph, click the job you want to see.
![Select job](/assets/images/help/images/overview-actions-result-navigate.png)
{% endif %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
1. View the results of each step.
![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated-2.png)
{% elsif currentVersion ver_gt "[email protected]" %}
1. Click on the job name to see the results of each step.
![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated.png)
{% else %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,14 @@ versions:
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow %}
{% data reusables.repositories.view-run %}
1. From the list of workflow runs, click the name of the `queued` or `in progress` run that you want to cancel.
![Name of workflow run](/assets/images/help/repository/in-progress-run.png)
1. In the upper-right corner of the workflow, click **Cancel workflow**.
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Cancel check suite button](/assets/images/help/repository/cancel-check-suite-updated.png)
{% else %}
![Cancel check suite button](/assets/images/help/repository/cancel-check-suite.png)
{% endif %}

### Steps {% data variables.product.prodname_dotcom %} takes to cancel a workflow run

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,8 @@ versions:
{% data reusables.repositories.navigate-to-workflow %}
{% data reusables.repositories.view-run %}
1. Under **Artifacts**, click the artifact you want to download.
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png)
{% else %}
![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png)
{% endif %}
1 change: 1 addition & 0 deletions content/actions/managing-workflow-runs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ versions:
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}{% link_in_list /using-the-visualization-graph %}{% endif %}
{% link_in_list /viewing-workflow-run-history %}
{% link_in_list /using-workflow-run-logs %}
{% link_in_list /manually-running-a-workflow %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,4 @@ versions:
{% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow %}
{% data reusables.repositories.view-run %}
1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**.
![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png)
1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down-updated.png){% else %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png){% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,11 @@ versions:
{% data reusables.repositories.navigate-to-workflow %}
{% data reusables.repositories.view-run %}
1. Under **Artifacts**, click {% octicon "trashcan" aria-label="The trashcan icon" %} next to the artifact you want to remove.
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact-updated.png)
{% else %}
![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact.png)
{% endif %}

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
### Setting the retention period for an artifact
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Using the visualization graph
intro: Every workflow run generates a real-time graph that illustrates the run progress. You can use this graph to monitor and debug workflows.
product: '{% data reusables.gated-features.actions %}'
versions:
free-pro-team: '*'
enterprise-server: '>=3.1'
---

{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.visualization-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow %}
{% data reusables.repositories.view-run %}

1. The graph displays each job in the workflow. An icon to the left of the job name indicates the status of the job. Lines between jobs indicate dependencies.
![Workflow graph](/assets/images/help/images/workflow-graph.png)

2. Click on a job to view the job log.
![Workflow graph](/assets/images/help/images/workflow-graph-job.png)
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ You can search the build logs for a particular step. When you search logs, only
{% data reusables.repositories.navigate-to-job-superlinter %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
1. In the upper-right corner of the log output, in the **Search logs** search box, type a search query.
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Search box to search logs](/assets/images/help/repository/search-log-box-updated-2.png)
{% else %}
![Search box to search logs](/assets/images/help/repository/search-log-box-updated.png)
{% endif %}
{% else %}
1. To expand each step you want to include in your search, click the step.
![Step name](/assets/images/help/repository/failed-check-step.png)
Expand All @@ -63,8 +67,12 @@ You can download the log files from your workflow run. You can also download a w
{% data reusables.repositories.view-run-superlinter %}
{% data reusables.repositories.navigate-to-job-superlinter %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Download log archive**.
1. In the upper right corner, click {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}{% octicon "gear" aria-label="The gear icon" %}{% else %}{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}{% endif %} and select **Download log archive**.
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down-updated-2.png)
{% else %}
![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down-updated.png)
{% endif %}
{% else %}
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Download log archive**.
![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down.png)
Expand All @@ -80,9 +88,17 @@ You can delete the log files from your workflow run. {% data reusables.repositor
{% data reusables.repositories.view-run-superlinter %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated-2.png)
{% else %}
![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated.png)
{% endif %}
2. To delete the log files, click the **Delete all logs** button and review the confirmation prompt.
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
![Delete all logs](/assets/images/help/repository/delete-all-logs-updated-2.png)
{% else %}
![Delete all logs](/assets/images/help/repository/delete-all-logs-updated.png)
{% endif %}
After deleting logs, the **Delete all logs** button is removed to indicate that no log files remain in the workflow run.
{% else %}
1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Billable job execution minutes are only shown for jobs run on private repositori
{% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow %}
{% data reusables.repositories.view-run %}
1. Under the job summary, you can view the job's execution time. To view the billable job execution time, click **Run and billable time details**.
1. Under the job summary, you can view the job's execution time. To view details about the billable job execution time, click the time under **Billable time**.
![Run and billable time details link](/assets/images/help/repository/view-run-billable-time.png)

{% note %}
Expand Down
5 changes: 5 additions & 0 deletions content/actions/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,13 @@ Committing the workflow file in your repository triggers the `push` event and ru
{% data reusables.repositories.actions-tab %}
{% data reusables.repositories.navigate-to-workflow-superlinter %}
{% data reusables.repositories.view-run-superlinter %}
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" %}
1. Under **Jobs** or in the visualization graph, click the **Lint code base** job.
![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job-updated.png)
{% else %}
1. In the left sidebar, click the **Lint code base** job.
![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job.png)
{% endif %}
{% data reusables.repositories.view-failed-job-results-superlinter %}
### More starter workflows
Expand Down
1 change: 1 addition & 0 deletions content/discussions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ featuredLinks:
- /discussions/guides/finding-discussions-across-multiple-repositories
- /discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions
- /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository
product_video: https://www.youtube-nocookie.com/embed/DbTWBP3_RbM
layout: product-landing
versions:
free-pro-team: '*'
Expand Down
4 changes: 2 additions & 2 deletions content/discussions/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ versions:

### Introduction

{% data variables.product.prodname_discussions %} {% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source project. Discussions are for conversations that need to be transparent and accessible but do not need to be tracked on a project board and are not related to code, unlike issues. Discussions enable fluid, open conversation in a public forum.
{% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source project. Discussions are for conversations that need to be transparent and accessible but do not need to be tracked on a project board and are not related to code, unlike issues. Discussions enable fluid, open conversation in a public forum.

Discussions give a space for more collaborative conversations by connecting and giving a more centralized area to connect and find information.

Expand Down Expand Up @@ -57,4 +57,4 @@ People with triage permissions for a repository can help moderate a project's di

### Next steps

Once there is a clear path to scope work out and move an idea from concept to reality, you can create an issue and start tracking your progress. For more information on creating an issue from a discussion, see, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)."
Once there is a clear path to scope work out and move an idea from concept to reality, you can create an issue and start tracking your progress. For more information on creating an issue from a discussion, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)."
Loading

0 comments on commit bdc9f69

Please sign in to comment.