Skip to content

Repo sync #27305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 91 commits into from
Aug 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
91 commits
Select commit Hold shift + click to select a range
5a8d641
Enable release
mattpollard Jul 18, 2023
0985ecc
Add placeholder pipeline data
mattpollard Jul 18, 2023
c395ebc
Add RC banner
mattpollard Jul 18, 2023
5864731
Merge branch 'main' into ghes-3.9-rc
mattpollard Jul 18, 2023
7ffed00
Merge branch 'main' into ghes-3.9-rc
mattpollard Jul 18, 2023
ceb6f76
Merge branch 'main' into ghes-3.9-rc
isaacmbrown Jul 20, 2023
ae8d4ba
Merge branch 'main' into ghes-3.9-rc
isaacmbrown Jul 21, 2023
d7a9d83
Remove references to git clone (#39378)
davidjarzebowski Jul 24, 2023
324fc56
Merge branch 'main' into rc-ghes-3.10
isaacmbrown Jul 26, 2023
335ed57
Merge branch 'main' into rc-ghes-3.10
isaacmbrown Jul 27, 2023
412effc
[GHES 3.10] Setting a custom maintenance message (#39718)
lecoursen Jul 27, 2023
175d61a
Merge branch 'main' into rc-ghes-3.10
isaacmbrown Jul 28, 2023
053fe9e
Merge branch 'main' into rc-ghes-3.10
isaacmbrown Jul 31, 2023
deb92c1
Merge branch 'main' into rc-ghes-3.10
isaacmbrown Aug 2, 2023
be1f02c
Retitling / minor reconfiguration of 'Configuring the CodeQL workflow…
subatoi Aug 2, 2023
42c8bcd
Merge branch 'rc-ghes-3.10' into subatoi/11449
subatoi Aug 3, 2023
0d775bd
Updates codeql_cli_ghes_recommended_version for GHES 3.10
subatoi Aug 3, 2023
82bf3a4
[GHES 3.10] Document save button for maintenance mode (#40220)
isaacmbrown Aug 4, 2023
e76c87d
Add release notes for GHES 3.10 release candidate (#39432)
isaacmbrown Aug 4, 2023
96909f5
Merge branch 'main' into rc-ghes-3.10
isaacmbrown Aug 4, 2023
8b00621
Better comparison whether 'ghes-3.10-2022-11-28/schema.json' is depre…
peterbe Aug 4, 2023
d4d1d6d
Update OpenAPI Description (#40293)
docs-bot Aug 4, 2023
c820abc
Fix link in release notes
isaacmbrown Aug 4, 2023
f607c7b
Update content/code-security/code-scanning/automatically-scanning-you…
subatoi Aug 5, 2023
0e2d8d0
Update content/code-security/code-scanning/automatically-scanning-you…
subatoi Aug 5, 2023
31b3231
Update content/code-security/code-scanning/automatically-scanning-you…
subatoi Aug 5, 2023
3c73b92
Update content/code-security/code-scanning/automatically-scanning-you…
subatoi Aug 5, 2023
5a6057c
Fix links
subatoi Aug 5, 2023
4747697
Removes unnecessary note
subatoi Aug 5, 2023
768708d
Adds content for GHES 3.10 self-hosted runners (Default setup analysis)
subatoi Aug 2, 2023
d9ab4d2
Small fixes
subatoi Aug 2, 2023
74ba867
Don't use enterprise hack
subatoi Aug 2, 2023
b4fc5f9
v2
subatoi Aug 3, 2023
7459097
Update content/code-security/code-scanning/automatically-scanning-you…
subatoi Aug 5, 2023
f81aae5
Update content/code-security/code-scanning/automatically-scanning-you…
subatoi Aug 5, 2023
decfe97
Update content/code-security/code-scanning/automatically-scanning-you…
subatoi Aug 5, 2023
1acce26
More changes based on feedback
subatoi Aug 5, 2023
8f94ca9
Reverse lib changes (did not fix remote build)
subatoi Aug 5, 2023
969fd06
Fix links (actually) this time...?
subatoi Aug 7, 2023
b00707e
Revert "Fix links (actually) this time...?"
subatoi Aug 7, 2023
8d45162
Fix known issues for GHES 3.10
isaacmbrown Aug 7, 2023
0e6fbc4
Merge branch 'rc-ghes-3.10' into subatoi/codeql-cli-rec-ghes310
felicitymay Aug 7, 2023
e606350
Proofread release notes
isaacmbrown Aug 7, 2023
55f1ae9
Merge pull request #40218 from github/subatoi/codeql-cli-rec-ghes310
subatoi Aug 7, 2023
4c7eb77
Really fix links this time :fingers-crossed
subatoi Aug 7, 2023
d4909f2
Update content/code-security/code-scanning/automatically-scanning-you…
subatoi Aug 7, 2023
c870e01
Update content/code-security/code-scanning/automatically-scanning-you…
subatoi Aug 7, 2023
b362a1e
Further feedback
subatoi Aug 7, 2023
3d88d7d
Merge branch 'subatoi/11449' into subatoi/10802
subatoi Aug 7, 2023
6828b01
Merge pull request #40170 from github/subatoi/10802
subatoi Aug 7, 2023
c0c3e09
Update data/reusables/code-scanning/autobuild-compiled-languages.md
subatoi Aug 7, 2023
cb5ca7f
Merge pull request #40158 from github/subatoi/11449
subatoi Aug 7, 2023
00e0528
Fixed spacing error in known issues section.
davidjarzebowski Aug 7, 2023
49efb3f
Updated the mbind known issue.
davidjarzebowski Aug 7, 2023
1a0c664
Copied known issue list from 3.9.0 to 3.9.1 releaes notes
davidjarzebowski Aug 7, 2023
b189957
Copied known issues section from 3.9.0 to 3.9.2
davidjarzebowski Aug 7, 2023
1de1a0f
Updated known issues list to match 3.9.0
davidjarzebowski Aug 7, 2023
4df3cea
Update data/release-notes/enterprise-server/3-10/0-rc1.yml
jc-clark Aug 7, 2023
069841e
Merge branch 'rc-ghes-3.10' into djj/release-note-updates
davidjarzebowski Aug 7, 2023
43949d9
Update data/release-notes/enterprise-server/3-10/0-rc1.yml
davidjarzebowski Aug 7, 2023
16116bc
Merge pull request #40365 from github/djj/release-note-updates
davidjarzebowski Aug 7, 2023
86eac0e
Added release note for OTel Changes
davidjarzebowski Aug 7, 2023
08f19dc
Update data/release-notes/enterprise-server/3-10/0-rc1.yml
jc-clark Aug 7, 2023
d2d88aa
add changes from 3-8/0-rc1.yml to 3-8/0.yml
jc-clark Aug 7, 2023
30caf3a
add errata and move release notes to "Repositories"
jc-clark Aug 7, 2023
58df8e4
fix yml spacing
jc-clark Aug 7, 2023
752fd5d
Adding new known issue about upgrades being blocked
davidjarzebowski Aug 7, 2023
2a5f69a
Added known issues for search bug and pre-upgrade check
davidjarzebowski Aug 7, 2023
2ef365c
Add CSV file with OTel changes in GHES 3.10
davidjarzebowski Aug 7, 2023
cd9658c
Merge branch 'rc-ghes-3.10' into djj/otel-change-in-ghes-3.10
davidjarzebowski Aug 7, 2023
60165b7
Update data/release-notes/enterprise-server/3-10/0-rc1.yml
davidjarzebowski Aug 7, 2023
b22ad73
Update data/release-notes/enterprise-server/3-10/0-rc1.yml
davidjarzebowski Aug 7, 2023
1fd220c
Update data/release-notes/enterprise-server/3-10/0-rc1.yml
davidjarzebowski Aug 7, 2023
ec39aac
Merge pull request #40369 from github/djj/ghes-3-10-rc-new-known-issues
davidjarzebowski Aug 7, 2023
bf6a9fe
Merge branch 'rc-ghes-3.10' into djj/otel-change-in-ghes-3.10
davidjarzebowski Aug 7, 2023
5cb8d22
Enforce consistency in known issue
davidjarzebowski Aug 8, 2023
9abd4dc
Merge pull request #40367 from github/djj/otel-change-in-ghes-3.10
davidjarzebowski Aug 8, 2023
5b3d9b5
Merge branch 'main' into rc-ghes-3.10
isaacmbrown Aug 8, 2023
e533f84
Add release note for Projects
isaacmbrown Aug 8, 2023
b57272b
Adding known issue
davidjarzebowski Aug 8, 2023
6256513
Adding known issue.
davidjarzebowski Aug 8, 2023
c7ba5e9
Adding known issue
davidjarzebowski Aug 8, 2023
3723b3c
Merge pull request #40402 from github/djj/more-known-issue-updates
davidjarzebowski Aug 8, 2023
bea0968
Added warning message about updated known issue list.
davidjarzebowski Aug 8, 2023
6cba7f9
Added warning message about updated known issues.
davidjarzebowski Aug 8, 2023
8844165
Moved known issue correction to top of release notes
davidjarzebowski Aug 8, 2023
f62a45c
Moved known issue correction to top of release notes
davidjarzebowski Aug 8, 2023
f913e15
Fixed typo
davidjarzebowski Aug 8, 2023
ba66138
Apply suggestions from code review
isaacmbrown Aug 8, 2023
5412d9b
Merge pull request #40406 from github/djj/missing-known-issues-warnin…
davidjarzebowski Aug 8, 2023
00cc403
Merge pull request #39577 from github/rc-ghes-3.10
jc-clark Aug 8, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 159 additions & 0 deletions assets/ghes-3.10-opentelemetry-attribute-mappings.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
Category,Old Attribute,New Attribute
API,reason,gh.api.error_reason
API,resource,gh.api.resource_type
API,graphql,gh.api.graphql
API,graphql_time,graphql.time
API,graphql_query_byte_size,graphql.query.byte_size
API,graphql_variables_byte_size,graphql.variables.byte_size
API,graphql_operation_name,graphql.operation.name
API,graphql_origin,graphql.origin
API,graphql_success,graphql.success
API,graphql_query_depth,graphql.query.depth
API,graphql_query_complexity,graphql.query.complexity
API,graphql_schema,graphql.schema
API,graphql_query_hash,graphql.query.hash
API,graphql_variables_hash,graphql.variables.hash
API,graphql_query_name,graphql.query.name
API,graphql_operation_id,graphql.operation.id
Repos,rename_id,gh.branch_protection_rule.repository_branch_renamer.id
Repos,end_date,gh.repo.purge.end_date
Repos,deleted_count,gh.repo.mirror.deleted_count
CodeScanning,pull_request_id,gh.pull_request.id
CodeScanning,pull_request_number,gh.pull_request.number
CodeScanning,pull_request_head,gh.pull_request.head_sha
CodeScanning,alerts_count,gh.code_scanning.alert.count
CodeScanning,file_path,gh.code_scanning.alert.file_path
CodeScanning,alert_number,gh.code_scanning.alert.number
CodeScanning,category,gh.code_scanning.analysis.category
CodeScanning,check_run_id,gh.check_run.id
CodeScanning,alerts_in_the_diff,gh.code_scanning.diff.alerts.in
CodeScanning,alerts_out_the_diff,gh.code_scanning.diff.alerts.out
CodeScanning,onboarding_comment_posted,gh.code_scanning.onboarding_comment.posted
CodeScanning,onboarding_comments_count,gh.code_scanning.onboarding_comments.count
CodeScanning,tool_name,gh.code_scanning.tool
CodeScanning,code_scanning_review_comment,gh.code_scanning.review_comment.id
CodeScanning,head_commit_oid,gh.pull_request.head_sha
CodeScanning,merge_commit_oid,gh.pull_request.merge_sha
CodeScanning,checkrun_previously_completed,gh.check_run.previously_completed
CodeScanning,job_reason,gh.code_scanning.job.reason
CodeScanning,time_in_secs,gh.code_scanning.job.time
CodeScanning,code_scanning_check_suite,gh.check_suite.id
CodeScanning,base_ref_name,gh.pull_request.base_ref.name
CodeScanning,pull_request_old,gh.pull_request.id.old
CodeScanning,pull_request_new,gh.pull_request.id.new
CodeScanning,repo_nwo,gh.repo.nwo
CodeScanning,skip_check_runs,gh.code_scanning.skip_check_runs
CodeScanning,refs,git.refs
CodeScanning,ref,git.ref
CodeScanning,commit_oid,git.commit.oid
CodeScanning,sarif_size,gh.code_scanning.sarif.size
CodeScanning,sarif_id,gh.code_scanning.sarif.id
CodeScanning,sarif_uri,gh.code_scanning.sarif.uri
CodeScanning,old_base_ref,gh.pull_request.base_ref.old
CodeScanning,new_base_ref,gh.pull_request.base_ref.new
CodeScanning,replication_lag,gh.freno.replication_delay
CodeScanning,key,gh.kv.key
External Identities,external_id,gh.external_identities.external_id
External Identities,oid,gh.external_identities.oid
External Identities,refresh_token,gh.external_identities.refresh_token
External Identities,email,gh.external_identities.email
External Identities,type,gh.external_identities.type
External Identities,key,gh.external_identities.cache_key
External Identities,body,gh.external_identities.cache_body
External Identities,expires,gh.external_identities.cache_expires
External Identities,cap_message,gh.external_identities.cap_message
External Identities,token_url,gh.external_identities.token_url
External Identities,credential_auth_org_id,gh.external_identities.credential_auth_org_id
External Identities,credential_auth_exists_for_target_org,gh.external_identities.credential_auth_exists_for_target_org
External Identities,resource_type,gh.external_identities.resource_type
External Identities,can_self_identify_internal_or_public,gh.external_identities.can_self_identify_internal_or_public
Memex,column_id,gh.memex.column.id
Memex,class_name,code.namespace
Memex,actor_id,gh.actor.id
Memex,project_item_id,gh.memex.item.id
Memex,value,gh.memex.column.value
Memex,result,gh.memex.column.update_result
Memex,memex_id,gh.memex.id
Memex,ns,code.namespace
Memex,fn,code.function
Memex,result,gh.job.result
Memex,on_tasklist_waitlist,gh.memex.tasklist_waitlist
Memex,id,gh.membership.id
Memex,member_id,gh.membership.member.id
Notifyd,subject_type,gh.notifyd.subject.type
Webhooks,file,code.filepath
Webhooks,catalog_service,gh.catalog_service
Webhooks,request_id,gh.request_id
Webhooks,fn,code.namespace & code.function
Webhooks,event,gh.webhook.event_type
Webhooks,action,gh.webhook.action
Webhooks,method,code.function
Webhooks,event_type,gh.webhook.event_type
Webhooks,model_name,code.namespace
Webhooks,id,gh.webhook.id
Webhooks,push_sha,gh.webhook.push_sha
Webhooks,parent,gh.webhook.parent
Webhooks,guid,gh.webhook.delivery_guid
Webhooks,hook_ids,gh.webhooks
Webhooks,repo_id,gh.repo.id
Webhooks,org_id,gh.org.id
Webhooks,user_id,gh.user.id
Webhooks,webhook_delivery_id,gh.webhook.delivery_guid
Webhooks,repo_database_id,gh.repo.id
Webhooks,repo_global_id,gh.repo.global_id
Webhooks,event_at,gh.webhook.reminder_event.event_at
Webhooks,event_type_db,gh.webhook.reminder_event.event_type_db
Webhooks,personal,gh.webhook.reminder_event.reminder_event.personal
Webhooks,pull_request_ids,gh.pull_request.id
Webhooks,pull_request_ids_for_author,pull_request_ids_for_author
Webhooks,actor_id,gh.actor.id
Webhooks,actor_login,gh.actor.login
Webhooks,user_login,gh.user.login
Webhooks,path,code.filepath
Webhooks,enterprise,gh.webhook.is_enterprise
Webhooks,job,gh.job.name
Webhooks,class,exception.type
Webhooks,payload_size,gh.webhook.payload_size
Webhooks,target_repository_nwo,gh.repo.name_with_owner
Webhooks,target_repository_id,gh.repo.id
Webhooks,target_organization_id,gh.org.id
Webhooks,target_organization_name,gh.org.name
Scheduled Reminders,transaction_id,gh.scheduled_reminders.transaction_id
Camo,request_id,gh.request.id
Camo,hmac,gh.camo.request_hmac
Camo,url,gh.camo.encoded_url
Camo,referer,gh.request.referer
Camo,error,gh.camo.error
Camo,dns-time,gh.camo.dns.time
Camo,resp,gh.camo.upstream.response
Camo,len,gh.camo.upstream.response.content_length
Camo,request,gh.camo.upstream.request_buf
Camo,response,gh.camo.upstream.response_buf
Camo,code,gh.camo.upstream.response.code
Camo,resp,gh.camo.response
Camo,ctype,gh.camo.upstream.response.content_type
Camo,pem,gh.camo.certfile.name
Notifications,fn,code.function
Notifications,id,gh.notifications.rollup_summary.id
Notifications,fn,code.function
repo migration,fn,code.namespace
repo migration,migration_guid,gh.repo_migration.migration_guid
repo migration,source_url,gh.repo_migration.model_source_url
repo migration,resolution,gh.repo_migration.resolution
repo migration,model_name,gh.repo_migration.model_name
repo migration,migratable_resource_id,gh.repo_migration.migratable_resource_id
repo migration,model_id,gh.repo_migration.model_id
repo migration,source_owner,gh.repo_migration.source_owner
repo migration,source_repository,gh.repo_migration.source_repository
repo migration,target_url,gh.repo_migration.model_target_url
repo migration,translator_url,gh.repo_migration.model_translator_url
repo migration,state,gh.repo_migration.model_state
repo migration,asset_storage,gh.repo_migration.asset_storage.type
repo migration,asset_type,gh.repo_migration.asset_storage.asset_type
repo migration,asset_id,gh.repo_migration.asset_storage.asset_id
repo migration,http_response_code,gh.repo_migration.asset_storage.http_response_code
repo migration,field,gh.repo_migration.field
repo migration,state,gh.repo_migration.state
repo migration,url,gh.repo_migration.repository.repository_url
repo migration,validation_error,validation_error
repo migration,code,code
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ topics:
- Upgrades
shortTitle: Configure maintenance mode
---

## About maintenance mode

Some types of operations require that you take {% data variables.location.product_location %} offline and put it into maintenance mode:
Expand All @@ -48,10 +49,12 @@ You can perform initial validation of your maintenance operation by configuring
1. In the top navigation bar, click **Maintenance**.

![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Maintenance", is highlighted with an orange outline.](/assets/images/enterprise/management-console/maintenance-tab.png)
1. Under "Enable and schedule", select **Enable maintenance mode**, then decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time.
1. Under "Enable and schedule", {% ifversion custom-maintenance-mode-message %}select **Enable maintenance mode**, then {% endif %}decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time.
- To enable maintenance mode immediately, select the dropdown menu and click **now**.
- To schedule a maintenance window for a future time, select the dropdown menu and click a start time.
{% data reusables.enterprise_management_console.save-settings %}
{% data reusables.enterprise_management_console.custom-maintenance-message %}
{% ifversion custom-maintenance-mode-message %}1. When you're satisfied with the timing of the window and the optional message, click **Save**. If you selected "now", your instance will be put into maintenance mode immediately.
{% else %}1. When you're satisfied with the timing of the window, select the checkbox next to "Enable maintenance mode". If you selected "now", your instance will be put into maintenance mode immediately.{% endif %}

{% ifversion ip-exception-list %}

Expand All @@ -70,6 +73,7 @@ You can also use a command-line utility to configure the IP exception list. For
![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Maintenance", is highlighted with an orange outline.](/assets/images/enterprise/management-console/maintenance-tab.png)
1. Under "Enable and configure IP exception list", select **Enable IP exception list**.
1. To the right of the checkbox for enabling the list, type a valid list of space-separated IP addresses or CIDR blocks that should be allowed to access {% data variables.location.product_location %}.
{% data reusables.enterprise_management_console.custom-maintenance-message %}
1. Click **Save**.

{% endif %}
Expand All @@ -89,6 +93,12 @@ $ ghe-maintenance -q
# Queries the current mode
$ ghe-maintenance -s
# Sets maintenance mode
{%- ifversion custom-maintenance-mode-message %}
$ ghe-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-maintenance -m "MESSAGE"
# Updates the custom message
{%- endif %}
$ ghe-maintenance -u
# Unsets maintenance mode
```
Expand All @@ -104,6 +114,12 @@ $ ghe-cluster-maintenance -q
# Queries the current mode
$ ghe-cluster-maintenance -s
# Sets maintenance mode
{%- ifversion custom-maintenance-mode-message %}
$ ghe-cluster-maintenance -s "MESSAGE"
# Sets maintenance mode with a custom message
$ ghe-cluster-maintenance -m "MESSAGE"
# Updates the custom message
{%- endif %}
$ ghe-cluster-maintenance -u
# Unsets maintenance mode
```
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ For more information, see [{% data variables.product.prodname_enterprise_backup_

## Installing {% data variables.product.prodname_enterprise_backup_utilities %}

To install {% data variables.product.prodname_enterprise_backup_utilities %} on your backup host, we recommend cloning the project's Git repository. This approach allows you to fetch new releases directly using Git, and your existing backup configuration file, `backup.config`, will be preserved when installing a new version.
To install {% data variables.product.prodname_enterprise_backup_utilities %} on your backup host, we recommend you download the relevant {% data variables.product.prodname_enterprise_backup_utilities %} release as a compressed archive, then extract and install the contents. For more information, see [Getting started](https://github.com/github/backup-utils/blob/master/docs/getting-started.md) in the github/backup-utils repository.

Alternatively, if the host machine can't access the internet, you can download each {% data variables.product.prodname_enterprise_backup_utilities %} release as a compressed archive, then extract and install the contents. For more information, see [Getting started](https://github.com/github/backup-utils/blob/master/docs/getting-started.md) in the {% data variables.product.prodname_enterprise_backup_utilities %} project documentation.
Downloading the release as a compressed archive ensures you are using the correct version of {% data variables.product.prodname_enterprise_backup_utilities %} for {% data variables.location.product_location %}, and that your existing backup configuration file, `backup.config`, will be preserved when installing a new version.

Backup snapshots are written to the disk path set by the `GHE_DATA_DIR` data directory variable in your `backup.config` file. Snapshots need to be stored on a filesystem which supports symbolic and hard links.

Expand All @@ -70,10 +70,12 @@ Backup snapshots are written to the disk path set by the `GHE_DATA_DIR` data dir

{% endnote %}

1. To clone the [{% data variables.product.prodname_enterprise_backup_utilities %} project repository](https://github.com/github/backup-utils/) to a local directory on your backup host, run the following command.
1. Download the relevant {% data variables.product.prodname_enterprise_backup_utilities %} release from the [Releases](https://github.com/github/backup-utils/releases) page of the github/backup-utils repository.

```
git clone https://github.com/github/backup-utils.git /path/to/target/directory/backup-utils
1. To extract the repository using tar, run the following command.

```shell
tar -xzvf /path/to/github-backup-utils-vMAJOR.MINOR.PATCH.tar.gz
```

1. To change into the local repository directory, run the following command.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ You can configure {% data variables.product.prodname_code_scanning %} to run {%

{% ifversion code-scanning-runner-label %}
If you are provisioning a self-hosted runner for {% data variables.product.prodname_codeql %} analysis, your runner must use a {% data variables.product.prodname_codeql %}-supported operating system version and CPU architecture. For more information, see the [{% data variables.product.prodname_codeql %} system requirements](https://codeql.github.com/docs/codeql-overview/system-requirements/).

{% ifversion code-scanning-default-setup-self-hosted-310 %}
If you are using default setup for {% data variables.product.prodname_code_scanning %}, assign the `code-scanning` label to your self-hosted runner. For more information about using labels with self-hosted runners, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners)". For more information about using default setup for code scanning analysis of compiled languages, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/codeql-code-scanning-for-compiled-languages)."

{% endif %}
{% endif %}

You must ensure that Git is in the PATH variable on any self-hosted runners you use to run {% data variables.product.prodname_codeql %} actions.
Expand Down Expand Up @@ -87,8 +92,7 @@ If you configure the {% data variables.product.prodname_codeql %} action sync to
1. If you want to download action workflows on demand from {% data variables.product.prodname_dotcom_the_website %}, you need to enable {% data variables.product.prodname_github_connect %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/managing-github-connect#enabling-github-connect)."
1. You'll also need to enable {% data variables.product.prodname_actions %} for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server)."
1. The next step is to configure access to actions on {% data variables.product.prodname_dotcom_the_website %} using {% data variables.product.prodname_github_connect %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)."
1. Add a self-hosted runner to your repository, organization, or enterprise account. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."{% ifversion code-scanning-runner-label %}
1. If you are using default setup for {% data variables.product.prodname_code_scanning %}, assign the `code-scanning` label to your self-hosted runner. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners)" and "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-default-setup-for-code-scanning)."{% endif %}
1. Add a self-hosted runner to your repository, organization, or enterprise account. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."

## Running code scanning using the {% data variables.product.prodname_codeql_cli %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ This view will also show error messages. For more information, see "[Debugging u

A file is reported as scanned by {% data variables.product.prodname_codeql %} if some of the lines of code in that file were processed. If you're using a standard configuration of the {% data variables.product.prodname_codeql %} action, the scanned files shown in the {% data variables.code-scanning.tool_status_page %} will include source code files for all languages that {% data variables.product.prodname_codeql %} can analyze. If you use advanced setup, you can optionally define which files for interpreted languages should be scanned using the `paths` and `paths-ignore` configuration properties. For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql)" and "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning)."

For compiled languages, the {% data variables.code-scanning.tool_status_page %} reports files that were present before running autobuild or any manual build steps. This means that files generated during the build process are not shown in the {% data variables.code-scanning.tool_status_page %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages#about-autobuild-for-codeql)."
For compiled languages, the {% data variables.code-scanning.tool_status_page %} reports files that were present before running autobuild or any manual build steps. This means that files generated during the build process are not shown in the {% data variables.code-scanning.tool_status_page %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/codeql-code-scanning-for-compiled-languages#about-autobuild-for-codeql)."

The tool status page will calculate the percentage of files that were scanned by {% data variables.product.prodname_codeql %} for each language supported by {% data variables.product.prodname_codeql %}. This percentage respects any files excluded by the `paths` and `paths-ignore` configuration properties.

Expand Down
Loading