Skip to content

Commit

Permalink
Merge branch 'main' into actions/pull_request_target-anchor
Browse files Browse the repository at this point in the history
  • Loading branch information
nguyenalex836 committed Sep 16, 2024
2 parents 94d934c + 1db5f9e commit f89e0ef
Show file tree
Hide file tree
Showing 70 changed files with 365 additions and 141 deletions.
1 change: 1 addition & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ jobs:
- observability
# - open-source
- pageinfo
- pagelist
# - pages
- products
- redirects
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ redirect_from:
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-access-to-your-user-accounts-project-boards
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-access-to-your-personal-accounts-project-boards
versions:
fpt: '*'
ghes: '*'
ghec: '*'
feature: projects-v1
topics:
- Accounts
shortTitle: 'Manage {% data variables.projects.projects_v1_boards %} access'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ redirect_from:
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account
versions:
fpt: '*'
ghes: '*'
ghec: '*'
feature: projects-v1
topics:
- Accounts
shortTitle: '{% data variables.projects.projects_v1_board_caps %} permissions'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For information on how to use labels to route jobs to specific types of self-hos

{% data reusables.actions.self-hosted-runner-management-permissions-required %}

>[!NOTE]Action Runner Controller does not support multiple labels, to find our more please read our [Action Runner Controller documentation](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller#using-arc-runners-in-a-workflow)
>[!NOTE]Actions Runner Controller does not support multiple labels, to find out more please read our [Actions Runner Controller documentation](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller#using-arc-runners-in-a-workflow)
## Creating a custom label

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ shortTitle: Use runners in a workflow

You can target self-hosted runners for use in a workflow based on the labels assigned to the runners{% ifversion target-runner-groups %}, or their group membership, or a combination of these{% endif %}.

>[!NOTE]Action Runner Controller does not support multiple labels, only the name of the runner can be used in place of a label
>[!NOTE]Actions Runner Controller does not support multiple labels, only the name of the runner can be used in place of a label
## About self-hosted runner labels

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Below is an example of the syntax for each system.

```yaml
my_job:
image: node:10.16-jessie
image: node:20-bookworm-slim
```

{% endraw %}
Expand All @@ -137,7 +137,7 @@ my_job:
```yaml
jobs:
my_job:
container: node:10.16-jessie
container: node:20-bookworm-slim
```

{% endraw %}
Expand Down Expand Up @@ -369,7 +369,7 @@ container-job:
POSTGRES_HOST: postgres
# The default PostgreSQL port
POSTGRES_PORT: 5432
image: node:10.18-jessie
image: node:20-bookworm-slim
services:
- postgres
script:
Expand All @@ -391,7 +391,7 @@ container-job:
jobs:
container-job:
runs-on: ubuntu-latest
container: node:10.18-jessie
container: node:20-bookworm-slim

services:
postgres:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ To update your workflows for OIDC, you will need to make two changes to your YAM

The `aws-actions/configure-aws-credentials` action receives a JWT from the {% data variables.product.prodname_dotcom %} OIDC provider, and then requests an access token from AWS. For more information, see the AWS [documentation](https://github.com/aws-actions/configure-aws-credentials).

* `BUCKET-NAME`: Add the name of your S3 bucket here.
* `AWS-REGION`: Add the name of your AWS region here.
* `BUCKET-NAME`: Replace this with the name of your S3 bucket.
* `AWS-REGION`: Replace this with the name of your AWS region.
* `ROLE-TO-ASSUME`: Replace this with your AWS role. For example, `arn:aws:iam::1234567890:role/example-role`

```yaml copy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ redirect_from:
- /actions/guides/moving-assigned-issues-on-project-boards
- /actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards
versions:
fpt: '*'
ghes: '*'
ghec: '*'
feature: projects-v1
type: tutorial
topics:
- Workflows
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ redirect_from:
- /actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column
- /actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column
versions:
fpt: '*'
ghes: '*'
ghec: '*'
feature: projects-v1
type: tutorial
topics:
- Workflows
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
# Containers must run in Linux based operating systems
runs-on: ubuntu-latest
# Docker Hub image that `container-job` executes in
container: node:10.18-jessie
container: node:20-bookworm-slim

# Service containers to run with `container-job`
services:
Expand Down Expand Up @@ -103,7 +103,7 @@ jobs:
# Containers must run in Linux based operating systems
runs-on: ubuntu-latest
# Docker Hub image that `container-job` executes in
container: node:10.18-jessie
container: node:20-bookworm-slim

# Service containers to run with `container-job`
services:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
# Containers must run in Linux based operating systems
runs-on: ubuntu-latest
# Docker Hub image that `container-job` executes in
container: node:10.18-jessie
container: node:20-bookworm-slim

# Service containers to run with `container-job`
services:
Expand Down Expand Up @@ -100,7 +100,7 @@ jobs:
# Containers must run in Linux based operating systems
runs-on: ubuntu-latest
# Docker Hub image that `container-job` executes in
container: node:10.18-jessie
container: node:20-bookworm-slim

# Service containers to run with `container-job`
services:
Expand Down
2 changes: 1 addition & 1 deletion content/actions/writing-workflows/about-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ If your job requires a database or cache service, you can use the [`services`](/
jobs:
container-job:
runs-on: ubuntu-latest
container: node:10.18-jessie
container: node:20-bookworm-slim
services:
postgres:
image: postgres
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ jobs:
steps:
- shell: pwsh
run: |
"mypath" | Out-File -FilePath $env:GITHUB_PATH -Append
"mypath" >> $env:GITHUB_PATH
```

{% endnote %}
Expand All @@ -652,7 +652,7 @@ echo "{environment_variable_name}={value}" >> "$GITHUB_ENV"
* Using PowerShell version 6 and higher:

```powershell copy
"{environment_variable_name}={value}" | Out-File -FilePath $env:GITHUB_ENV -Append
"{environment_variable_name}={value}" >> $env:GITHUB_ENV
```

* Using PowerShell version 5.1 and below:
Expand Down Expand Up @@ -698,7 +698,7 @@ steps:
- name: Set the value
id: step_one
run: |
"action_state=yellow" | Out-File -FilePath $env:GITHUB_ENV -Append
"action_state=yellow" >> $env:GITHUB_ENV
- name: Use the value
id: step_two
run: |
Expand Down Expand Up @@ -750,10 +750,10 @@ steps:
- name: Set the value in pwsh
id: step_one
run: |
$EOF = -join (1..15 | ForEach {[char]((48..57)+(65..90)+(97..122) | Get-Random)})
"JSON_RESPONSE<<$EOF" | Out-File -FilePath $env:GITHUB_ENV -Append
(Invoke-WebRequest -Uri "https://example.com").Content | Out-File -FilePath $env:GITHUB_ENV -Append
"$EOF" | Out-File -FilePath $env:GITHUB_ENV -Append
$EOF = (New-Guid).Guid
"JSON_RESPONSE<<$EOF" >> $env:GITHUB_ENV
(Invoke-WebRequest -Uri "https://example.com").Content >> $env:GITHUB_ENV
"$EOF" >> $env:GITHUB_ENV
shell: pwsh
```

Expand All @@ -774,7 +774,7 @@ echo "{name}={value}" >> "$GITHUB_OUTPUT"
{% powershell %}

```powershell copy
"{name}=value" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
"{name}=value" >> $env:GITHUB_OUTPUT
```

{% endpowershell %}
Expand Down Expand Up @@ -805,7 +805,7 @@ This example demonstrates how to set the `SELECTED_COLOR` output parameter and l
- name: Set color
id: color-selector
run: |
"SELECTED_COLOR=green" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
"SELECTED_COLOR=green" >> $env:GITHUB_OUTPUT
- name: Get color
env:{% raw %}
SELECTED_COLOR: ${{ steps.color-selector.outputs.SELECTED_COLOR }}{% endraw %}
Expand All @@ -827,7 +827,7 @@ echo "{markdown content}" >> $GITHUB_STEP_SUMMARY
{% powershell %}

```powershell copy
"{markdown content}" | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
"{markdown content}" >> $env:GITHUB_STEP_SUMMARY
```

{% endpowershell %}
Expand All @@ -851,7 +851,7 @@ echo "### Hello world! :rocket:" >> $GITHUB_STEP_SUMMARY
{% powershell %}

```powershell copy
"### Hello world! :rocket:" | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
"### Hello world! :rocket:" >> $env:GITHUB_STEP_SUMMARY
```

{% endpowershell %}
Expand Down Expand Up @@ -883,11 +883,11 @@ For multiline Markdown content, you can use `>>` to continuously append content
```yaml
- name: Generate list using Markdown
run: |
"This is the lead in sentence for the list" | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
"" | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append # this is a blank line
"- Lets add a bullet point" | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
"- Lets add a second bullet point" | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
"- How about a third one?" | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
"This is the lead in sentence for the list" >> $env:GITHUB_STEP_SUMMARY
"" >> $env:GITHUB_STEP_SUMMARY # this is a blank line
"- Lets add a bullet point" >> $env:GITHUB_STEP_SUMMARY
"- Lets add a second bullet point" >> $env:GITHUB_STEP_SUMMARY
"- How about a third one?" >> $env:GITHUB_STEP_SUMMARY
```

{% endpowershell %}
Expand All @@ -914,8 +914,8 @@ To clear all content for the current step, you can use `>` to overwrite any prev
```yaml
- name: Overwrite Markdown
run: |
"Adding some Markdown content" | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
"There was an error, we need to clear the previous Markdown with some new content." | Out-File -FilePath $env:GITHUB_STEP_SUMMARY
"Adding some Markdown content" >> $env:GITHUB_STEP_SUMMARY
"There was an error, we need to clear the previous Markdown with some new content." >> $env:GITHUB_STEP_SUMMARY
```

{% endpowershell %}
Expand All @@ -942,7 +942,7 @@ To completely remove a summary for the current step, the file that `GITHUB_STEP_
```yaml
- name: Delete all summary content
run: |
"Adding Markdown content that we want to remove before the step ends" | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
"Adding Markdown content that we want to remove before the step ends" >> $env:GITHUB_STEP_SUMMARY
Remove-Item $env:GITHUB_STEP_SUMMARY
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,8 @@ on:
page_build
```

{% ifversion projects-v1 %}

## `project`

| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
Expand Down Expand Up @@ -566,6 +568,8 @@ on:
types: [created, deleted]
```

{% endif %}

## `public`

| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,17 @@ shortTitle: Projects policies

## About policies for projects in your enterprise

You can enforce policies to control how enterprise members manage {% data variables.projects.projects_v2_and_v1 %}, or you can allow organization owners to manage policies for {% data variables.projects.projects_v2_and_v1 %} at the organization level.{% ifversion project-visibility-policy %}
You can enforce policies to control how enterprise members manage {% data variables.projects.projects_v2_and_v1 %}, or you can allow organization owners to manage policies for {% data variables.projects.projects_v2_and_v1 %} at the organization level.

{% ifversion projects-v1 %}

Some policies apply to both {% data variables.product.prodname_projects_v2 %}, the new projects experience, and {% data variables.product.prodname_projects_v1 %}, the previous experience, while some apply only to {% data variables.product.prodname_projects_v1 %}. For more information about each experience, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)" and "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)."
{% else %}For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)."{% endif %}

{% endif %}

## Enforcing a policy for organization-wide projects

Across all organizations owned by your enterprise, you can enable or disable organization-wide {% data variables.projects.projects_v1_boards %}, or allow owners to administer the setting on the organization level.
Across all organizations owned by your enterprise, you can enable or disable organization-wide {% data variables.projects.projects_v2 %}, or allow owners to administer the setting on the organization level.

{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,11 @@ If you use an enterprise with {% data variables.product.prodname_emus %}, member

## About usernames for {% data variables.enterprise.prodname_managed_users %}

When your {% data variables.enterprise.prodname_emu_enterprise %} is created, you will choose a short code that will be used as the suffix for your enterprise members' usernames. {% data reusables.enterprise-accounts.emu-shortcode %} The setup user who configures SAML SSO has a username in the format of **SHORT-CODE_admin**.
When your {% data variables.enterprise.prodname_emu_enterprise %} is created, you will choose a short code that will be used as the suffix for your enterprise members' usernames. {% data reusables.enterprise-accounts.emu-shortcode %}

When you provision a new user from your identity provider, the new {% data variables.enterprise.prodname_managed_user %} will have a {% data variables.product.prodname_dotcom %} username in the format of **@IDP-USERNAME_SHORT-CODE**. The IDP-USERNAME component is formed by normalizing the SCIM `userName` attribute value sent from the IdP.
The setup user who configures SAML SSO has a username in the format of **SHORT-CODE_admin**. For example, if your enterprise's shortcode is "octo", the setup user will be "octo_admin."

When you provision a new user from your identity provider, the new {% data variables.enterprise.prodname_managed_user %} will have a {% data variables.product.prodname_dotcom %} username in the format of **@IDP-USERNAME_SHORT-CODE** (for example, "mona-cat_octo"). The IDP-USERNAME component is formed by normalizing the SCIM `userName` attribute value sent from the IdP.

| Identity provider | {% data variables.product.prodname_dotcom %} username |
|-----------------------------------|----------------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,10 @@ Since {% data variables.product.prodname_github_apps %} are a first class actor

### Pros of installation access tokens

* Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API).
* Dedicated rate limits that grow with your organization.
* Decoupled from {% data variables.product.prodname_dotcom %} user identities, so they do not consume any licensed seats.
* Never granted a password, so cannot be directly signed in to.
* Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API)
* Dedicated rate limits that grow with your organization
* Decoupled from {% data variables.product.prodname_dotcom %} user identities, so they do not consume any licensed seats
* Never granted a password, so cannot be directly signed in to

### Cons of installation access tokens

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ shortTitle: About mandatory 2FA
## About eligibility for mandatory 2FA

Your account is selected for mandatory 2FA if you have taken some action on {% data variables.product.product_name %} that shows you are a contributor. Eligible actions include:
* Publishing an app or action for others.
* Creating a release for your repository.
* Contributing to specific high-importance repositories, such as [the projects tracked by the Open Source Security Foundation](https://github.com/ossf/wg-securing-critical-projects#current-work).
* Being an administrator of a high-importance repository.
* Being an organization owner for an organization containing repositories or other users.
* Being an enterprise administrator.
* Publishing an app or action for others
* Creating a release for your repository
* Contributing to specific high-importance repositories, such as [the projects tracked by the Open Source Security Foundation](https://github.com/ossf/wg-securing-critical-projects#current-work)
* Being an administrator of a high-importance repository
* Being an organization owner for an organization containing repositories or other users
* Being an enterprise administrator

{% data variables.product.prodname_dotcom %} is continually assessing improvements to our account security features and 2FA requirements, so these criteria may change over time.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ You can provide the source root for conversion from absolute to relative URIs in

* [`checkout_path`](https://github.com/github/codeql-action/blob/c2c0a2908e95769d01b907f9930050ecb5cf050d/analyze/action.yml#L44-L47) input to the `github/codeql-action/analyze` action
* `checkout_uri` parameter to the SARIF upload API endpoint. For more information, see "[AUTOTITLE](/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data)."
* [`invocation.workingDirectory.uri`](https://docs.oasis-open.org/sarif/sarif/v2.1.0/csprd01/sarif-v2.1.0-csprd01.html#_Toc9244365) property in the SARIF file
* [`invocations[0].workingDirectory.uri`](https://docs.oasis-open.org/sarif/sarif/v2.1.0/csprd01/sarif-v2.1.0-csprd01.html#_Toc9244365) property in the `run` object in the SARIF file

If you provide a source root, any location of an artifact specified using an absolute URI must use the same URI scheme. If there is a mismatch between the URI scheme for the source root and one or more of the absolute URIs, the upload is rejected.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ type: overview
* Sending responses to users in the {% data variables.product.prodname_copilot_chat_short %} window
* Execution of {% data variables.product.company_short %} (first party) or functions on external services (third party)

{% data variables.product.prodname_copilot_extensions_short %} can be used with:

{% data reusables.copilot.copilot-extensions.compatible-chat-interfaces %}

## Visibility of {% data variables.product.prodname_copilot_extensions_short %}

{% data variables.product.prodname_copilot_extensions_short %} can be private, public and shareable, or public and listed on the {% data variables.product.prodname_marketplace %}. Which visibility option you choose will depend on your use case and the audience you are targeting.
Expand Down
Loading

0 comments on commit f89e0ef

Please sign in to comment.