From 1704bf7a84e1a092b69da50cebd22d26f0ca5b5f Mon Sep 17 00:00:00 2001 From: mLuby Date: Sun, 11 Sep 2022 13:40:45 -0400 Subject: [PATCH 1/9] Fix broken #syntax-exceptions link --- .../customizing-your-repository/about-code-owners.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 969a1a3430..f81efeca5c 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -119,6 +119,7 @@ apps/ @octocat {% warning %} +### Syntax exceptions **Warning:** There are some syntax rules for gitignore files that *do not work* in CODEOWNERS files: - Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment - Using `!` to negate a pattern From 68bfe6318814e336fed700fec537561f1df200ac Mon Sep 17 00:00:00 2001 From: mLuby Date: Sun, 11 Sep 2022 15:23:45 -0400 Subject: [PATCH 2/9] Fix unwanted space above header --- .../customizing-your-repository/about-code-owners.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index f81efeca5c..d1dee908de 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -119,8 +119,7 @@ apps/ @octocat {% warning %} -### Syntax exceptions -**Warning:** There are some syntax rules for gitignore files that *do not work* in CODEOWNERS files: +**Warning:** There are some syntax rules for gitignore files that *do not work* in CODEOWNERS files: - Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment - Using `!` to negate a pattern - Using `[ ]` to define a character range From 3d2a52387b1bf6304e4d2a64ff874cafacfe936b Mon Sep 17 00:00:00 2001 From: Greg Deane Date: Mon, 19 Sep 2022 09:13:14 +0200 Subject: [PATCH 3/9] Update search result description for secret gists Mention that secret gists do appear in the search results for the person who created them, assuming they are logged in. --- .../editing-and-sharing-content-with-gists/creating-gists.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md index ce5486664c..3498bf556a 100644 --- a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md +++ b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md @@ -21,7 +21,7 @@ Every gist is a Git repository, which means that it can be forked and cloned. {% Gists can be {% ifversion ghae %}internal{% else %}public{% endif %} or secret. {% ifversion ghae %}Internal{% else %}Public{% endif %} gists show up in {% data variables.gists.discover_url %}, where {% ifversion ghae %}enterprise members{% else %}people{% endif %} can browse new gists as they're created. They're also searchable, so you can use them if you'd like other people to find and see your work. -Secret gists don't show up in {% data variables.gists.discover_url %} and are not searchable. Secret gists aren't private. If you send the URL of a secret gist to {% ifversion ghae %}another enterprise member{% else %}a friend{% endif %}, they'll be able to see it. However, if {% ifversion ghae %}any other enterprise member{% else %}someone you don't know{% endif %} discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead. +Secret gists don't show up in {% data variables.gists.discover_url %} and are not searchable (exception: if you are logged in and have created a secret gist, it will appear in the search results). Secret gists aren't private. If you send the URL of a secret gist to {% ifversion ghae %}another enterprise member{% else %}a friend{% endif %}, they'll be able to see it. However, if {% ifversion ghae %}any other enterprise member{% else %}someone you don't know{% endif %} discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead. {% data reusables.gist.cannot-convert-public-gists-to-secret %} From f9a5adcbad9dbe65e5f8a50b9f5dba07a60de4ba Mon Sep 17 00:00:00 2001 From: Dev Prakash Sharma Date: Tue, 20 Sep 2022 01:55:45 +0530 Subject: [PATCH 4/9] Added description for `github.secret_source` --- content/actions/learn-github-actions/contexts.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/actions/learn-github-actions/contexts.md b/content/actions/learn-github-actions/contexts.md index 74256153a3..29bea830cf 100644 --- a/content/actions/learn-github-actions/contexts.md +++ b/content/actions/learn-github-actions/contexts.md @@ -211,6 +211,7 @@ The `github` context contains information about the workflow run and the event t {%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-4722 %} | `github.run_attempt` | `string` | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. | {%- endif %} +| `github.secret_source` | `string` | The secret used when the workflow is triggered by Dependabot event or other actors. It can be `None`, `Actions`, or `Dependabot`. | | `github.server_url` | `string` | The URL of the GitHub server. For example: `https://github.com`. | | `github.sha` | `string` | {% data reusables.actions.github_sha_description %} | | `github.token` | `string` | A token to authenticate on behalf of the GitHub App installed on your repository. This is functionally equivalent to the `GITHUB_TOKEN` secret. For more information, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)."
Note: This context property is set by the Actions runner, and is only available within the execution `steps` of a job. Otherwise, the value of this property will be `null`. |{% ifversion actions-stable-actor-ids %} From 3b591481f6505eb554ce8d1e90ec1e2a1dc3f48a Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Tue, 27 Sep 2022 12:02:31 -0700 Subject: [PATCH 5/9] update wording --- .../editing-and-sharing-content-with-gists/creating-gists.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md index 3498bf556a..d661f15ac2 100644 --- a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md +++ b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md @@ -21,7 +21,7 @@ Every gist is a Git repository, which means that it can be forked and cloned. {% Gists can be {% ifversion ghae %}internal{% else %}public{% endif %} or secret. {% ifversion ghae %}Internal{% else %}Public{% endif %} gists show up in {% data variables.gists.discover_url %}, where {% ifversion ghae %}enterprise members{% else %}people{% endif %} can browse new gists as they're created. They're also searchable, so you can use them if you'd like other people to find and see your work. -Secret gists don't show up in {% data variables.gists.discover_url %} and are not searchable (exception: if you are logged in and have created a secret gist, it will appear in the search results). Secret gists aren't private. If you send the URL of a secret gist to {% ifversion ghae %}another enterprise member{% else %}a friend{% endif %}, they'll be able to see it. However, if {% ifversion ghae %}any other enterprise member{% else %}someone you don't know{% endif %} discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead. +Secret gists don't show up in {% data variables.gists.discover_url %} and are not searchable unless you are logged in and are the author of the secret gist. Secret gists aren't private. If you send the URL of a secret gist to {% ifversion ghae %}another enterprise member{% else %}a friend{% endif %}, they'll be able to see it. However, if {% ifversion ghae %}any other enterprise member{% else %}someone you don't know{% endif %} discovers the URL, they'll also be able to see your gist. If you need to keep your code away from prying eyes, you may want to [create a private repository](/articles/creating-a-new-repository) instead. {% data reusables.gist.cannot-convert-public-gists-to-secret %} From 3b49aeff024076d677ccea69d9482fce936e08e1 Mon Sep 17 00:00:00 2001 From: Jess Hosman <1183847+jhosman@users.noreply.github.com> Date: Tue, 27 Sep 2022 16:21:10 -0600 Subject: [PATCH 6/9] Add versioning and minor change to description text --- content/actions/learn-github-actions/contexts.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/actions/learn-github-actions/contexts.md b/content/actions/learn-github-actions/contexts.md index 29bea830cf..1eeb6460c7 100644 --- a/content/actions/learn-github-actions/contexts.md +++ b/content/actions/learn-github-actions/contexts.md @@ -211,7 +211,9 @@ The `github` context contains information about the workflow run and the event t {%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-4722 %} | `github.run_attempt` | `string` | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. | {%- endif %} -| `github.secret_source` | `string` | The secret used when the workflow is triggered by Dependabot event or other actors. It can be `None`, `Actions`, or `Dependabot`. | +{%- ifversion fpt or ghec or ghes > 3.3 %} +| `github.secret_source` | `string` | The source of a secret used in a workflow. Possible values are `None`, `Actions`, `Dependabot`, or `Codespaces`. | +{%- endif %} | `github.server_url` | `string` | The URL of the GitHub server. For example: `https://github.com`. | | `github.sha` | `string` | {% data reusables.actions.github_sha_description %} | | `github.token` | `string` | A token to authenticate on behalf of the GitHub App installed on your repository. This is functionally equivalent to the `GITHUB_TOKEN` secret. For more information, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)."
Note: This context property is set by the Actions runner, and is only available within the execution `steps` of a job. Otherwise, the value of this property will be `null`. |{% ifversion actions-stable-actor-ids %} From 0d3329a1b17510bfa0ccdf3ee442a946da15e00c Mon Sep 17 00:00:00 2001 From: Jess Hosman <1183847+jhosman@users.noreply.github.com> Date: Tue, 27 Sep 2022 16:47:48 -0600 Subject: [PATCH 7/9] Add ghae version --- content/actions/learn-github-actions/contexts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/learn-github-actions/contexts.md b/content/actions/learn-github-actions/contexts.md index 1eeb6460c7..4c2736aa35 100644 --- a/content/actions/learn-github-actions/contexts.md +++ b/content/actions/learn-github-actions/contexts.md @@ -211,7 +211,7 @@ The `github` context contains information about the workflow run and the event t {%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-4722 %} | `github.run_attempt` | `string` | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. | {%- endif %} -{%- ifversion fpt or ghec or ghes > 3.3 %} +{%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %} | `github.secret_source` | `string` | The source of a secret used in a workflow. Possible values are `None`, `Actions`, `Dependabot`, or `Codespaces`. | {%- endif %} | `github.server_url` | `string` | The URL of the GitHub server. For example: `https://github.com`. | From daaaa6c40ec240b5e00516cfc135b9b5a1e9a292 Mon Sep 17 00:00:00 2001 From: Courtney Wilson <77312589+cmwilson21@users.noreply.github.com> Date: Tue, 27 Sep 2022 20:49:30 -0500 Subject: [PATCH 8/9] Update about-code-owners.md --- .../about-code-owners.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index d1dee908de..e946d405ad 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -47,7 +47,16 @@ To reduce the size of your CODEOWNERS file, consider using wildcard patterns to ## CODEOWNERS syntax -A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files, with [some exceptions](#syntax-exceptions). The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. Users and teams must have explicit `write` access to the repository, even if the team's members already have access. +{% warning %} + +**Warning:** There are some syntax rules for gitignore files that *do not work* in CODEOWNERS files: +- Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment +- Using `!` to negate a pattern +- Using `[ ]` to define a character range + +{% endwarning %} + +A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files. The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. Users and teams must have explicit `write` access to the repository, even if the team's members already have access. {% ifversion fpt or ghec%}In most cases, you{% else %}You{% endif %} can also refer to a user by an email address that has been added to their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, for example `user@example.com`. {% ifversion fpt or ghec %} You cannot use an email address to refer to a {% data variables.product.prodname_managed_user %}. For more information about {% data variables.product.prodname_managed_users %}, see "[About {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}{% endif %} @@ -117,15 +126,6 @@ apps/ @octocat /apps/github ``` -{% warning %} - -**Warning:** There are some syntax rules for gitignore files that *do not work* in CODEOWNERS files: -- Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment -- Using `!` to negate a pattern -- Using `[ ]` to define a character range - -{% endwarning %} - ## CODEOWNERS and branch protection Repository owners can add branch protection rules to ensure that changed code is reviewed by the owners of the changed files. For more information, see "[About protected branches](/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." From 4a71b8b2733a3b44199f63171315ad095f4f704e Mon Sep 17 00:00:00 2001 From: Courtney Wilson <77312589+cmwilson21@users.noreply.github.com> Date: Tue, 27 Sep 2022 20:50:20 -0500 Subject: [PATCH 9/9] Update about-code-owners.md --- .../customizing-your-repository/about-code-owners.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index e946d405ad..574e436a38 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -49,7 +49,7 @@ To reduce the size of your CODEOWNERS file, consider using wildcard patterns to {% warning %} -**Warning:** There are some syntax rules for gitignore files that *do not work* in CODEOWNERS files: +**Warning:** There are some syntax rules for gitignore files that *do not work* in CODEOWNERS files: - Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment - Using `!` to negate a pattern - Using `[ ]` to define a character range