Skip to content

Commit

Permalink
Merge branch 'main' into revert-20087-revert-20069-fix-homepage-versi…
Browse files Browse the repository at this point in the history
…ons-dropdown
  • Loading branch information
sarahs authored Jun 24, 2021
2 parents 8cb3f02 + a73a8dc commit cffafaf
Show file tree
Hide file tree
Showing 2,013 changed files with 7,036 additions and 6,842 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/confirm-internal-staff-work-in-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:
owner: 'github',
repo: process.env.TEAM_CONTENT_REPO,
title: `@${context.payload.sender.login} confirm that \#${issueNo} should be in the public github/docs repo`,
body: `@${context.payload.sender.login} opened https://github.com/github/docs/issues/${issueNo} publicly in the github/docs repo, instead of the private github/docs-internal repo.\n\n@${context.payload.sender.login}, please confirm that this belongs in the public repo and that no sensitive information was disclosed by commenting below and closing the issue.\n\nIf this was not intentional and sensitive information was shared, please delete https://github.com/github/docs/issues/${issueNo} and notify us in the \#docs-open-source channel.\n\nThanks!`,
body: `@${context.payload.sender.login} opened https://github.com/github/docs/issues/${issueNo} publicly in the github/docs repo, instead of the private github/${process.env.TEAM_CONTENT_REPO} repo.\n\n@${context.payload.sender.login}, please confirm that this belongs in the public repo and that no sensitive information was disclosed by commenting below and closing the issue.\n\nIf this was not intentional and sensitive information was shared, please delete https://github.com/github/docs/issues/${issueNo} and notify us in the \#docs-open-source channel.\n\nThanks!`,
labels: ['OS confirmation'],
});
Expand All @@ -75,4 +75,4 @@ jobs:
with:
channel: ${{ secrets.DOCS_OPEN_SOURCE_SLACK_CHANNEL_ID }}
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
text: <@${{github.actor}}> opened https://github.com/github/docs/issues/${{ github.event.number || github.event.issue.number }} publicly on the github/docs repo instead of the private github/docs-internal repo. They have been notified via a new issue in the github/docs-internal repo to confirm this was intentional.
text: <@${{github.actor}}> opened https://github.com/github/docs/issues/${{ github.event.number || github.event.issue.number }} publicly on the github/docs repo instead of a private repo. They have been notified via a new issue in the private repo to confirm this was intentional.
Binary file modified assets/images/help/projects/example_board.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 modified assets/images/help/projects/move_between_group.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/projects/priority_example.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 modified assets/images/help/projects/project-view-switch.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/help/projects/status_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ Example that applies to GitHub.com and recent versions of GitHub Enterprise Serv
```yaml
title: About your personal dashboard
versions:
free-pro-team: '*'
enterprise-server: '>=2.20'
fpt: '*'
ghes: '>=2.20'
```
Example that applies to all supported versions of GitHub Enterprise Server:
Expand All @@ -71,15 +71,15 @@ Example that applies to all supported versions of GitHub Enterprise Server:
```yaml
title: Downloading your license
versions:
enterprise-server: '*'
ghes: '*'
```
You can also version a page for a range of releases. This would version the page for GitHub Enterprise Server 2.22 and 3.0 only:
You can also version a page for a range of releases. This would version the page for GitHub.com, and GitHub Enterprise Server versions 2.22 and 3.0 only:
```yaml
versions:
free-pro-team: '*'
enterprise-server: '>=2.22 <3.1'
fpt: '*'
ghes: '>=2.22 <3.1'
```
### `redirect_from`
Expand Down Expand Up @@ -310,7 +310,7 @@ When using Liquid conditionals in lists or tables, you can use [whitespace contr
Just add a hyphen on either the left, right, or both sides to indicate that there should be no newline on that side. For example, this statement removes a newline on the left side:

```
{%- if currentVersion == 'free-pro-team@latest' %}
{%- ifversion fpt %}
```

## Links and image paths
Expand Down
14 changes: 7 additions & 7 deletions content/actions/creating-actions/about-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ redirect_from:
- /actions/automating-your-workflow-with-github-actions/about-actions
- /actions/building-actions/about-actions
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
github-ae: '*'
fpt: '*'
ghes: '>=2.22'
ghae: '*'
type: overview
topics:
- Action development
Expand All @@ -25,7 +25,7 @@ topics:

You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with {% data variables.product.prodname_dotcom %}'s APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code.

{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
You can write your own actions to use in your workflow or share the actions you build with the {% data variables.product.prodname_dotcom %} community. To share actions you've built, your repository must be public.
{% endif %}

Expand Down Expand Up @@ -65,11 +65,11 @@ A _composite run steps_ action allows you to combine multiple workflow run steps

If you're developing an action for other people to use, we recommend keeping the action in its own repository instead of bundling it with other application code. This allows you to version, track, and release the action just like any other software.

{% if currentVersion == "free-pro-team@latest" %}
{% ifversion fpt %}
Storing an action in its own repository makes it easier for the {% data variables.product.prodname_dotcom %} community to discover the action, narrows the scope of the code base for developers fixing issues and extending the action, and decouples the action's versioning from the versioning of other application code.
{% endif %}

{% if currentVersion == "free-pro-team@latest" %}If you're building an action that you don't plan to make available to the public, you {% else %} You{% endif %} can store the action's files in any location in your repository. If you plan to combine action, workflow, and application code in a single repository, we recommend storing actions in the `.github` directory. For example, `.github/actions/action-a` and `.github/actions/action-b`.
{% ifversion fpt %}If you're building an action that you don't plan to make available to the public, you {% else %} You{% endif %} can store the action's files in any location in your repository. If you plan to combine action, workflow, and application code in a single repository, we recommend storing actions in the `.github` directory. For example, `.github/actions/action-a` and `.github/actions/action-b`.

## Compatibility with {% data variables.product.prodname_ghe_server %}

Expand Down Expand Up @@ -127,7 +127,7 @@ steps:
### Using a commit's SHA for release management
Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %}
Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% ifversion fpt or ghes > 3.0 or ghae %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %}
```yaml
steps:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Creating a composite run steps action
intro: 'In this guide, you''ll learn how to build a composite run steps action.'
product: '{% data reusables.gated-features.actions %}'
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
github-ae: '*'
fpt: '*'
ghes: '>=2.22'
ghae: '*'
type: tutorial
topics:
- Action development
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ redirect_from:
- /actions/automating-your-workflow-with-github-actions/creating-a-docker-container-action
- /actions/building-actions/creating-a-docker-container-action
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
github-ae: '*'
fpt: '*'
ghes: '>=2.22'
ghae: '*'
type: tutorial
topics:
- Action development
Expand All @@ -36,7 +36,7 @@ Once you complete this project, you should understand how to build your own Dock
You may find it helpful to have a basic understanding of {% data variables.product.prodname_actions %} environment variables and the Docker container filesystem:

- "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)"
{% if currentVersion == "github-ae@latest" %}
{% ifversion ghae %}
- "[Docker container filesystem](/actions/using-github-hosted-runners/about-ae-hosted-runners#docker-container-filesystem)."
{% else %}
- "[Virtual environments for {% data variables.product.prodname_dotcom %}](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners#docker-container-filesystem)"
Expand Down Expand Up @@ -185,7 +185,7 @@ Now you're ready to test your action out in a workflow. When an action is in a p

### Example using a public action

The following workflow code uses the completed _hello world_ action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. {% if currentVersion == "free-pro-team@latest" %}Public actions can be used even if they're not published to {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)." {% endif %}
The following workflow code uses the completed _hello world_ action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. {% ifversion fpt %}Public actions can be used even if they're not published to {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)." {% endif %}

{% raw %}
**.github/workflows/main.yml**
Expand All @@ -210,7 +210,7 @@ jobs:

### Example using a private action

Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% if currentVersion == "free-pro-team@latest" %}This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository.{% endif %}
Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% ifversion fpt %}This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository.{% endif %}

{% raw %}
**.github/workflows/main.yml**
Expand All @@ -237,9 +237,9 @@ jobs:
```
{% endraw %}

From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}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.
From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae %}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 "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}
{% ifversion fpt or ghes > 3.0 or ghae %}
![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)
Expand Down
12 changes: 6 additions & 6 deletions content/actions/creating-actions/creating-a-javascript-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ redirect_from:
- /actions/automating-your-workflow-with-github-actions/creating-a-javascript-action
- /actions/building-actions/creating-a-javascript-action
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
github-ae: '*'
fpt: '*'
ghes: '>=2.22'
ghae: '*'
type: tutorial
topics:
- Action development
Expand Down Expand Up @@ -270,11 +270,11 @@ jobs:
```
{% endraw %}
From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}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.
From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae %}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 "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}
{% ifversion fpt or ghes > 3.0 or ghae %}
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png)
{% elsif currentVersion ver_gt "enterprise-server@2.22" %}
{% elsif ghes > 2.22 %}
![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
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ product: '{% data reusables.gated-features.actions %}'
redirect_from:
- /actions/building-actions/dockerfile-support-for-github-actions
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
github-ae: '*'
type: 'reference'
fpt: '*'
ghes: '>=2.22'
ghae: '*'
type: reference
---

{% data reusables.actions.enterprise-beta %}
Expand Down
6 changes: 3 additions & 3 deletions content/actions/creating-actions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ redirect_from:
- /actions/building-actions
- /articles/creating-a-github-action/
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
github-ae: '*'
fpt: '*'
ghes: '>=2.22'
ghae: '*'
children:
- /about-actions
- /creating-a-docker-container-action
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ redirect_from:
- /actions/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions
- /actions/building-actions/metadata-syntax-for-github-actions
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
github-ae: '*'
type: 'reference'
fpt: '*'
ghes: '>=2.22'
ghae: '*'
type: reference
---

{% data reusables.actions.enterprise-beta %}
Expand Down Expand Up @@ -253,7 +253,7 @@ For more information, see "[`github context`](/actions/reference/context-and-exp

#### `runs.steps[*].env`

**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step.
**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% ifversion fpt or ghes > 2.22 or ghae %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step.

#### `runs.steps[*].working-directory`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ redirect_from:
- /actions/automating-your-workflow-with-github-actions/publishing-actions-in-github-marketplace
- /actions/building-actions/publishing-actions-in-github-marketplace
versions:
free-pro-team: '*'
type: 'how_to'
fpt: '*'
type: how_to
---

{% data reusables.actions.ae-beta %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ product: '{% data reusables.gated-features.actions %}'
redirect_from:
- /actions/building-actions/setting-exit-codes-for-actions
versions:
free-pro-team: '*'
enterprise-server: '>=2.22'
github-ae: '*'
type: 'how_to'
fpt: '*'
ghes: '>=2.22'
ghae: '*'
type: how_to
---

{% data reusables.actions.enterprise-beta %}
Expand Down
Loading

0 comments on commit cffafaf

Please sign in to comment.