Skip to content

Commit 03bbd97

Browse files
authored
Merge branch 'main' into andrewlayman-patch-1
2 parents d1facaf + aa28caa commit 03bbd97

36 files changed

Lines changed: 677 additions & 113 deletions

.github/workflows/browser-test.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ name: Browser Tests
22

33
on:
44
workflow_dispatch:
5-
push:
6-
branches:
7-
- main
8-
pull_request:
5+
# push:
6+
# branches:
7+
# - main
8+
# pull_request:
99

1010
jobs:
1111
see_if_should_skip:

assets/images/help/desktop/click-branch-in-drop-down.png renamed to assets/images/help/desktop/click-branch-in-drop-down-mac.png

File renamed without changes.

content/actions/creating-actions/metadata-syntax-for-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ runs:
299299

300300
#### `runs.image`
301301

302-
**Required** The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file.
302+
**Required** The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, the file must be named `Dockerfile` and you must use a path relative to your action metadata file. The `docker` application will execute this file.
303303

304304
#### `runs.env`
305305

content/actions/learn-github-actions/essential-features-of-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ jobs:
7575
run: |
7676
expr 1 + 1 > output.log
7777
- name: Upload output file
78-
uses: actions/upload-artifact@v1
78+
uses: actions/upload-artifact@v2
7979
with:
8080
name: output-log-file
8181
path: output.log

content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ GitHub Actions
117117
</tr>
118118
</table>
119119
120-
{% data variables.product.prodname_actions %} caching is only applicable to {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "<a href="/actions/guides/caching-dependencies-to-speed-up-workflows" class="dotcom-only">Caching dependencies to speed up workflows</a>."
120+
{% data variables.product.prodname_actions %} caching is only applicable for repositories hosted on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "<a href="/actions/guides/caching-dependencies-to-speed-up-workflows" class="dotcom-only">Caching dependencies to speed up workflows</a>."
121121
122122
{% data variables.product.prodname_actions %} does not have an equivalent of CircleCI’s Docker Layer Caching (or DLC).
123123

content/actions/learn-github-actions/security-hardening-for-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ This means that a compromise of a single action within a workflow can be very si
7777

7878
### Considering cross-repository access
7979

80-
{% data variables.product.product_name %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying workflow files. Users have specific permissions for each repository, so having the `GITHUB_TOKEN` for one repository grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators.
80+
{% data variables.product.prodname_actions %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying workflow files. Users have specific permissions for each repository, so having the `GITHUB_TOKEN` for one repository grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators.
8181

8282
We have [a plan on the {% data variables.product.prodname_dotcom %} roadmap](https://github.com/github/roadmap/issues/74) to support a flow that allows cross-repository access within {% data variables.product.product_name %}, but this is not yet a supported feature. Currently, the only way to perform privileged cross-repository interactions is to place a {% data variables.product.prodname_dotcom %} authentication token or SSH key as a secret within the workflow. Because many authentication token types do not allow for granular access to specific resources, there is significant risk in using the wrong token type, as it can grant much broader access than intended.
8383

content/actions/reference/encrypted-secrets.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,12 @@ When generating credentials, we recommend that you grant the minimum permissions
7777

7878
If your repository {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0"or currentVersion == "github-ae@latest" %}has environment secrets or {% endif %}can access secrets from the parent organization, then those secrets are also listed on this page.
7979

80+
{% note %}
81+
82+
**Note:** Users with collaborator access can use the REST API to manage secrets for a repository. For more information, see "[{% data variables.product.prodname_actions %} secrets API](/rest/reference/actions#secrets)."
83+
84+
{% endnote %}
85+
8086
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" }
8187
### Creating encrypted secrets for an environment
8288

content/actions/reference/workflow-syntax-for-github-actions.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -638,6 +638,27 @@ jobs:
638638
uses: docker://gcr.io/cloud-builders/gradle
639639
```
640640

641+
#### Example using action inside a different private repository than the workflow
642+
643+
Your workflow must checkout the private repository and reference the action locally.
644+
645+
{% raw %}
646+
```yaml
647+
jobs:
648+
my_first_job:
649+
steps:
650+
- name: Check out repository
651+
uses: actions/checkout@v2
652+
with:
653+
repository: octocat/my-private-repo
654+
ref: v1.0
655+
token: ${{ secrets.GITHUB_TOKEN }}
656+
path: ./.github/actions/my-private-repo
657+
- name: Run my action
658+
uses: ./.github/actions/my-private-repo/my-action
659+
```
660+
{% endraw %}
661+
641662
### `jobs.<job_id>.steps[*].run`
642663

643664
Runs command-line programs using the operating system's shell. If you do not provide a `name`, the step name will default to the text specified in the `run` command.

content/github/authenticating-to-github/using-ssh-over-the-https-port.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ To set this in your ssh config, edit the file at `~/.ssh/config`, and add this s
3333
Host {% data variables.command_line.codeblock %}
3434
Hostname ssh.{% data variables.command_line.codeblock %}
3535
Port 443
36+
User git
3637
```
3738
3839
You can test that this works by connecting once more to {% data variables.product.product_location %}:

content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You're under no obligation to choose a license. However, without a license, the
2323

2424
### Determining the location of your license
2525

26-
Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md).
26+
Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md` or `LICENSE.rst`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md).
2727

2828
Some projects include information about their license in their README. For example, a project's README may include a note saying "This project is licensed under the terms of the MIT license."
2929

0 commit comments

Comments
 (0)