Merge pull request #39041 from github/repo-sync

Repo sync

Author: docs-bot

.github/workflows/purge-old-workflow-runs.yml

@@ -10,7 +10,7 @@ shortTitle: About troubleshooting
 
 {% data reusables.actions.enterprise-github-hosted-runners %}
 
-## Troubleshooting your workflows
+## Initial troubleshooting suggestions
 
 There are several ways you can troubleshoot failed workflow runs.
 
@@ -30,18 +30,79 @@ Each workflow run generates activity logs that you can view, search, and downloa
 
 If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging).
 
-### Canceling a workflow
+If your workflow uses specific tools or actions, enabling their debug or verbose logging options can help generate more detailed output for troubleshooting.
+For example, you can use `npm install --verbose` for npm or `GIT_TRACE=1 GIT_CURL_VERBOSE=1 git ...` for git.
 
-If you attempt to cancel a workflow and the cancellation doesn't succeed, make sure you aren't using the `always` expression. The `always` expression causes a workflow step to run even when the workflow is canceled, which results in a hanging cancellation. For more information, see [AUTOTITLE](/actions/learn-github-actions/expressions#always).
+{% ifversion fpt or ghec %}
+
+## Reviewing billing errors
+
+Actions usage includes runner minutes and storage for [workflow artifacts](/actions/writing-workflows/choosing-what-your-workflow-does/storing-and-sharing-data-from-a-workflow). For more information, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-actions/about-billing-for-github-actions).
+
+### Setting a budget
+
+Setting an Actions budget may help immediately unblock workflows failing due to billing or storage errors. It will allow further minutes and storage usage to be billed up to the set budget amount. To learn more, see [AUTOTITLE](/billing/managing-your-billing/preventing-overspending).
+
+{% endif %}
 
 {% ifversion actions-metrics %}
 
-## Troubleshooting {% data variables.product.prodname_actions %} inefficiencies
+## Reviewing {% data variables.product.prodname_actions %} activity with metrics
 
-To analyze the inefficiencies and reliability of your workflows using metrics, see [AUTOTITLE](/actions/administering-github-actions/viewing-github-actions-metrics).
+To analyze the efficiency and reliability of your workflows using metrics, see [AUTOTITLE](/actions/administering-github-actions/viewing-github-actions-metrics).
 {% endif %}
 
-## Troubleshooting self-hosted runners
+## Troubleshooting workflow triggers
+
+You can review your workflow’s `on:` field to understand what is expected to trigger the workflow. For more information, see [AUTOTITLE](/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow).
+
+For a full list of available events, see [AUTOTITLE](/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
+
+### Triggering event conditions
+
+Some triggering events only run from the default branch (i.e. `issues`, `schedule`). Workflow file versions that exist outside of the default branch will not trigger on these events.
+
+Workflows will not run on `pull_request` activity if the pull request has a merge conflict.
+
+Workflows that would otherwise be triggered on `push` or `pull_request` activity will be skipped if the commit message contains a skip annotation. For more information, see [AUTOTITLE](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/skipping-workflow-runs).
+
+### Scheduled workflows running at unexpected times
+
+Scheduled events can be delayed during periods of high loads of {% data variables.product.prodname_actions %} workflow runs.
+
+High load times include the start of every hour. If the load is sufficiently high enough, some queued jobs may be dropped. To decrease the chance of delay, schedule your workflow to run at a different time of the hour. For more information, see [AUTOTITLE](/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#schedule).
+
+### Filtering and diff limits
+
+Specific events allow for filtering by branch, tag, and/or paths you can customize. Workflow run creation will be skipped if the filter conditions apply to filter out the workflow.
+
+You can use special characters with filters. For more information, see [AUTOTITLE](/actions/writing-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet).
+
+For path filtering, evaluating diffs is limited to the first 300 files. If there are files changed that are not matched in the first 300 files returned by the filter, the workflow will not be run. For more information, see [AUTOTITLE](/actions/writing-workflows/workflow-syntax-for-github-actions#git-diff-comparisons).
+
+## Troubleshoot workflow execution
+
+Workflow execution involves any issues seen after the workflow was triggered and a workflow run has been created.
+
+### Canceling Workflows
+
+If standard cancellation through the [UI](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/canceling-a-workflow) or [API](/rest/actions/workflow-runs?apiVersion=2022-11-28#cancel-a-workflow-run) does not process as expected, there may be a conditional statement configured for your running workflow job(s) that causes it to not cancel.
+
+In these cases, you can leverage the API to force cancel the run. For more information, see [AUTOTITLE](/rest/actions/workflow-runs?apiVersion=2022-11-28#force-cancel-a-workflow-run).
+
+A common cause can be using the `always()` [status check function](/actions/writing-workflows/choosing-what-your-workflow-does/evaluate-expressions-in-workflows-and-actions#status-check-functions) which returns `true`, even on cancellation. An alternative is to use the inverse of the `cancelled()` function, `{% raw %}${{ !cancelled() }}{% endraw %}`.
+
+For more information, see [AUTOTITLE](/actions/writing-workflows/choosing-when-your-workflow-runs/using-conditions-to-control-job-execution) and [AUTOTITLE](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/canceling-a-workflow#steps-github-takes-to-cancel-a-workflow-run).
+
+## Troubleshooting runners
+
+### Defining runner labels
+
+{% data variables.product.github %}-hosted runners leverage [preset labels](/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories) maintained through the [`actions/runner-images`](https://github.com/actions/runner-images?tab=readme-ov-file#available-images) repository.
+
+We recommend using unique label names for larger and self-hosted runners. If a label matches to any of the existing preset labels, there can be runner assignment issues where there is no guarantee on which matching runner option the job will run on.
+
+### Self-hosted runners
 
 If you use self-hosted runners, you can view their activity and diagnose common issues.
 

content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md

@@ -18,7 +18,7 @@ These terms apply to the pre-release software made available to you by GitHub. T
 
 ## 1. Pre-Release Software.
 
-  The software provided is a pre-release version. “Pre-release” means software, online services, and additional products and features that are provided for preview, evaluation, demonstration, or trial purposes, as well as prerelease versions of those such as alpha, beta, or early access versions.
+  The software provided is a pre-release version. “Pre-release” means software, online services, and additional products and features that are not yet generally available, such as alpha, beta, early access, technical preview, or similar versions.
 
   Pre-release software may not operate correctly. It may delete your data, corrupt your data, or have other bugs. It also may not work the way a final commercial version of the software will.
 
@@ -54,9 +54,17 @@ These terms apply to the pre-release software made available to you by GitHub. T
 
 ## 4. Data Collection and Usage.
 
-  a. **Consent to Data Collection.** The pre-release software may collect information about you and your use of the software, and send that information to GitHub. GitHub may use this information to provide services, to improve our products and services, or for any other purpose permitted under the GitHub Data Protection Agreement or GitHub Privacy Statement. Your use of the pre-release software operates as your consent to these practices.
-
-  b. **Use of Collected Data.** GitHub will use collected data for analytics and measurement to understand how our pre-release software and related products are used. The software will collect data and usage information about events generated when interacting with it. These events help us analyze and measure performance and features used. This usage information is used by GitHub and may be shared with affiliates and other third parties to help deliver, develop, evaluate, and improve the software and related products. We analyze data to ensure the pre-release software is working as intended, to evaluate the safety, reliability, and user experience of the software, and to investigate and detect potential abuse. We may combine the information we collect from the pre-release software with other data.
+  a. **Consent to Data Collection.** The pre-release software may collect telemetry information about you and your use of the software, and send that information to GitHub. Subject to the limitations in Section 4(b) below, GitHub may use this information to provide services, to improve our products and services, or for any other purpose permitted under the GitHub Data Protection Agreement or GitHub Privacy Statement. Your use of the pre-release software operates as your consent to these practices.
+
+  b. **Use of Collected Data.**
+  * GitHub will use collected data for analytics and measurement to understand how our pre-release software and related products are used.
+  * The software will collect data and usage information about events generated when interacting with it. These events help us analyze and measure performance and features used. This usage information is used by GitHub and may be shared with affiliates and other third parties to help deliver, develop, evaluate, and improve the software and related products.
+  * We analyze data to ensure the pre-release software is working as intended, to evaluate the safety, reliability, and user experience of the software, and to investigate and detect potential abuse.
+  * We may combine the information we collect from the pre-release software with other data.
+  * For pre-release software that uses AI:
+      * You retain ownership of the code that you input to the software.
+      * GitHub does not own the output sent to you by the software.
+      * GitHub will not use your inputs or the outputs generated to train AI language models, unless you have instructed us in writing to do so.
 
   c. **Processing of Personal Data.** GitHub is the data controller in relation to the Personal Data processed in connection with the pre-release software.
 

content/site-policy/github-terms/github-pre-release-license-terms.md

@@ -31,6 +31,7 @@
 | [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error |  |
 | [GH001](https://github.com/github/markdownlint-github/blob/main/docs/rules/GH001-no-default-alt-text.md) | no-default-alt-text | Images should have meaningful alternative text (alt text) | error | accessibility, images |
 | [GH002](https://github.com/github/markdownlint-github/blob/main/docs/rules/GH002-no-generic-link-text.md) | no-generic-link-text | Avoid using generic link text like `Learn more` or `Click here` | error | accessibility, links |
+| GHD030 | code-fence-line-length | Code fence lines should not exceed a maximum length | warning | code, accessibility |
 | GHD032 | image-alt-text-end-punctuation | Alternate text for images should end with punctuation | error | accessibility, images |
 | GHD004 | image-file-kebab-case | Image file names must use kebab-case | error | images |
 | GHD033 | incorrect-alt-text-length | Images alternate text should be between 40-150 characters | warning | accessibility, images |
@@ -65,4 +66,7 @@
 | GHD041 | third-party-action-pinning | Code examples that use third-party actions must always pin to a full length commit SHA | error | feature, actions |
 | GHD042 | liquid-tag-whitespace | Liquid tags should start and end with one whitespace. Liquid tag arguments should be separated by only one whitespace. | error | liquid, format |
 | GHD043 | link-quotation | Internal link titles must not be surrounded by quotations | error | links, url |
-| GHD044 | octicon-aria-labels | Octicons should always have an aria-label attribute even if aria-hidden. | warning | accessibility, octicons |
+| GHD044 | octicon-aria-labels | Octicons should always have an aria-label attribute even if aria-hidden. | warning | accessibility, octicons |
+| GHD048 | british-english-quotes | Periods and commas should be placed inside quotation marks (American English style) | warning | punctuation, quotes, style, consistency |
+| GHD050 | multiple-emphasis-patterns | Do not use more than one emphasis/strong, italics, or uppercase for a string | warning | formatting, emphasis, style |
+| GHD049 | note-warning-formatting | Note and warning tags should be formatted according to style guide | warning | formatting, callouts, notes, warnings, style |

data/reusables/contributing/content-linter-rules.md

@@ -72,7 +72,6 @@
     "prevent-pushes-to-main": "tsx src/workflows/prevent-pushes-to-main.ts",
     "purge-fastly-edge-cache": "tsx src/workflows/purge-fastly-edge-cache.ts",
     "purge-fastly-edge-cache-per-language": "tsx src/languages/scripts/purge-fastly-edge-cache-per-language.js",
-    "purge-old-workflow-runs": "tsx src/workflows/purge-old-workflow-runs.js",
     "ready-for-docs-review": "tsx src/workflows/ready-for-docs-review.ts",
     "release-banner": "tsx src/ghes-releases/scripts/release-banner.ts",
     "repo-sync": "./src/workflows/local-repo-sync.sh",
@@ -283,7 +282,7 @@
     "helmet": "^8.0.0",
     "highlight.js": "^11.11.1",
     "highlightjs-curl": "^1.3.0",
-    "hot-shots": "^10.0.0",
+    "hot-shots": "^11.1.0",
     "html-entities": "^2.5.6",
     "http-proxy-middleware": "^3.0.5",
     "imurmurhash": "^0.1.4",

package-lock.json

@@ -101,6 +101,12 @@ const githubDocsConfig = {
     'partial-markdown-files': true,
     'yml-files': true,
   },
+  'code-fence-line-length': {
+    // GHD030
+    severity: 'warning',
+    'partial-markdown-files': true,
+    'yml-files': true,
+  },
   'image-alt-text-exclude-words': {
     // GHD031
     severity: 'error',
@@ -174,6 +180,24 @@ const githubDocsConfig = {
     'partial-markdown-files': true,
     'yml-files': true,
   },
+  'british-english-quotes': {
+    // GHD048
+    severity: 'warning',
+    'partial-markdown-files': true,
+    'yml-files': true,
+  },
+  'note-warning-formatting': {
+    // GHD049
+    severity: 'warning',
+    'partial-markdown-files': true,
+    'yml-files': true,
+  },
+  'multiple-emphasis-patterns': {
+    // GHD050
+    severity: 'warning',
+    'partial-markdown-files': true,
+    'yml-files': true,
+  },
 }
 
 export const githubDocsFrontmatterConfig = {

package.json

@@ -481,9 +481,8 @@ export function AskAIResults({
           ></IconButton>
         </div>
       ) : null}
-      {!aiCouldNotAnswer && references && references.length > 0 ? (
+      {!aiCouldNotAnswer && !responseLoading && references && references.length > 0 ? (
         <>
-          <ActionList.Divider aria-hidden="true" />
           <ActionList className={styles.referencesList} showDividers>
             <ActionList.Group>
               <ActionList.GroupHeading

src/content-linter/style/github-docs.js

@@ -377,11 +377,11 @@ export function SearchOverlay({
         eventGroupId: askAIEventGroupId.current,
       })
       setSelectedIndex(-1)
+      setSearchLoading(true)
       updateParams({
         'search-overlay-ask-ai': 'true',
         'search-overlay-input': selectedOption.term,
       })
-      setSearchLoading(true)
       setAIQuery(selectedOption.term)
       inputRef.current?.focus()
     }
@@ -645,6 +645,7 @@ export function SearchOverlay({
             listElementsRef,
             askAIState,
             showSpinner,
+            searchLoading,
             previousSuggestionsListHeight,
           )}
         </ActionList>
@@ -673,6 +674,7 @@ export function SearchOverlay({
           listElementsRef,
           askAIState,
           showSpinner,
+          searchLoading,
           previousSuggestionsListHeight,
         )}
       </ActionList>
@@ -883,14 +885,16 @@ function renderSearchGroups(
     setAICouldNotAnswer: (value: boolean) => void
   },
   showSpinner: boolean,
+  searchLoading: boolean,
   previousSuggestionsListHeight: number | string,
 ) {
   const groups = []
 
   let isInAskAIState = askAIState?.isAskAIState && !askAIState.aiSearchError
   let isInAskAIStateButNoAnswer = isInAskAIState && askAIState.aiCouldNotAnswer
 
-  // already showing spinner when streaming AI response, so don't want to show 2 here
+  // This spinner is for both the AI search and the general search results.
+  // We already show a spinner when streaming AI response, so don't want to show 2 here
   if (showSpinner && !isInAskAIState) {
     groups.push(
       <Box
@@ -1005,7 +1009,19 @@ function renderSearchGroups(
         <ActionList.GroupHeading as="h3" tabIndex={-1}>
           {t('search.overlay.general_suggestions_list_heading')}
         </ActionList.GroupHeading>
-        {items}
+        {searchLoading && isInAskAIState ? (
+          <Box
+            role="status"
+            className={styles.loadingContainer}
+            sx={{
+              height: `${previousSuggestionsListHeight}px`,
+            }}
+          >
+            <Spinner />
+          </Box>
+        ) : (
+          items
+        )}
       </ActionList.Group>,
     )