version
+
+{% comment %}
+- Describe when and how to use available setup actions that configure the version of the language on the runner (ex. actions/setup-node).
+- How does the setup action configure the version and what happens when the version isn't supported in the environment. What is the default version, when no version is configured.
+- Include any additional features the setup action might provide that are useful to CI.
+- If applicable, provide examples of configuring exact versions or major/minor versions.
+- Include information about software already installed on GitHub-hosted runners or software configuration necessary to build and test the project.
+- Provide examples of configuring matrix strategies.
+- Link out to any docs about available software on the GitHub-hosted runners. (Ex. https://docs.github.com/en/actions/reference/software-installed-on-github-hosted-runners).
+- Include code samples.
+{% endcomment %}
+
+## Installing dependencies
+
+{% comment %}
+- Include example of installing dependencies to prepare for building and testing.
+- Are there any dependencies or scenarios where people might need to install packages globally?
+- Include examples of common package managers.
+- If the language is supported by GitHub Packages, include an example installing dependencies from GitHub.
+- Include code samples.
+{% endcomment %}
+
+## Caching dependencies
+
+{% comment %}
+Include an example of restoring cached dependencies. We'll want to link out to the article about caching for more information (https://docs.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows).
+{% endcomment %}
+
+## Building your code
+
+{% comment %}
+- Include any compile steps.
+- Include any test commands.
+- Note that you can use the same commands that your repository needs to build and test your code by simply replacing the commands in the `run` keyword.
+- Include any basic examples or commands specific to test frameworks.
+- Include any common databases or services that might be needed. If so, we can link out to the services guides in the docs (https://docs.github.com/en/actions/configuring-and-managing-workflows/using-databases-and-service-containers).
+{% endcomment %}
+
+## Packaging workflow data as artifacts
+
+{% comment %}
+This section can simply link out to https://docs.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts or provide additional information about which artifacts might be typical to upload for a CI workflow.
+{% endcomment %}{% endraw %}
+```
\ No newline at end of file
diff --git a/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md b/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md
new file mode 100644
index 0000000000..4c93dce91d
--- /dev/null
+++ b/content/contributing/writing-for-github-docs/using-videos-in-github-docs.md
@@ -0,0 +1,153 @@
+---
+title: Using videos in GitHub Docs
+shortTitle: Using videos
+intro: 'This guide explains how to create videos that support user needs for {% data variables.product.prodname_docs %}.'
+product: '{% data reusables.contributing.product-note %}'
+versions:
+ feature: 'contributing'
+---
+
+## About videos in {% data variables.product.prodname_docs %}
+
+Videos are used rarely in the {% data variables.product.prodname_docs %}. When videos are necessary to provide the best user experience for an article, they are used together with written text. Videos are not a replacement for written content. Videos should never be the only way information is communicated because they are more difficult to keep up to date and are not accessible to everyone.
+
+
+Use these guidelines to determine if a video is appropriate to include in an article or on a landing page in the docs.
+
+If you add a link to a video or embed a video in the {% data variables.product.prodname_docs %}, add the video's metadata to the "[Videos in {% data variables.product.prodname_docs %}](https://github.com/github/docs/blob/main/contributing/videos-in-github-docs.md)" file in the `github/docs` repository.
+
+The Docs team does not create or maintain video content. Videos are purely supplemental to help communicate significant or complex topics, and should be used sparingly because they are not a content type owned by the Docs team.
+
+## Video checklist
+
+Use this checklist to quickly determine if a video might be appropriate to add to an article or landing page.
+
+- Is the video the only way to communicate the information?
+- Does {% data variables.product.prodname_dotcom %} own the video?
+- Is the video well produced? (See the "[Best practices](#best-practices)" section for more information.)
+- Is the video accessible to the broadest group of users possible? (See the "[Accessibility requirements](#accessibility-requirements)" section for more information.)
+- Is the video less than five minutes long?
+- Does the video have a specific audience and purpose in the docs? If it is only relevant to a particular product or feature, you must version it. See the "[Versioning](#versioning)" section for more information.
+
+If you answer "no" to any of these items, the video is not suitable for adding to the {% data variables.product.prodname_docs %}.
+
+### Maintaining videos
+
+If a video has a maintenance schedule or a team directly responsible for auditing and updating the content if it becomes out of date, you can include the video without any additional steps.
+
+If the video does not have a maintenance schedule, create an issue with an appropriate target date to review or remove the video.
+
+## Best practices
+
+Use these best practices to help determine if a video is well produced and is of a high enough quality to be included in the {% data variables.product.prodname_docs %}.
+
+Good videos introduce an instructional agenda that includes steps and goals so that someone watching quickly knows what they will learn. Videos are demonstrative, both showing and explaining the relevant steps that are performed. Videos should be engaging and encouraging. Videos must be well produced to be included in the {% data variables.product.prodname_docs %}. A well produced video contains few barriers for people with disabilities, has professional narration (if it is a narrated video), has clear visuals, and comes from a trusted source such as {% data variables.product.prodname_dotcom %} or Microsoft.
+
+Videos are broadly grouped into three categories: product overviews, feature videos, and tutorials. These descriptions are generalizations of each video type. Some videos might not fit perfectly in one category, but can still be useful without meeting the exact guidelines.
+
+### Product overviews
+- **Purpose**: Briefly explain what the product is, showcase the main functionality, and get people interested
+- **Length**: Less than a minute
+- **Possible audiences**: People who want to know if a feature is useful for their goals, people who are new to {% data variables.product.company_short %} and trying to understand what the products do
+- **Possible locations in the docs**: Landing pages and guides
+
+### Feature videos
+- **Purpose**: Supplement conceptual or procedural content
+- **Length**: As short as possible, without exceeding five minutes. Break longer content into multiple shorter, focused videos
+- **Possible audiences**: People who are learning about or how to use a feature
+- **Possible locations in the docs**: Guides, conceptual articles, procedural articles
+
+### Tutorials
+- **Purpose**: Help novice users get going with a product, drive adoption, or explain complex functionalities
+- **Length**: Individual videos should be five minutes or less. Complex topics can have a series of shorter videos spread across an article. Total length should be a maximum of 15 minutes
+- **Possible audiences**: New users of features or products
+- **Possible locations**: Guides
+
+## When to use videos
+
+We might use videos instead of other visuals such as screenshots or diagrams when it is important to show movement or changes in state, like when someone navigates from one screen to another or demos a feature that involves progressing through multiple menus. However, screenshots or text may be sufficient to explain these procedures.
+
+Videos can also be helpful to introduce features or products where a 30 second video can supplement information that requires multiple paragraphs to write.
+
+Use videos that explain the value of the procedure or concept that they are showing.
+
+## When to not use videos
+
+Do not use videos for features that change quickly and may make videos out of date. Do not use videos that contradict the written content or violate any parts of the "[AUTOTITLE](/contributing/writing-for-github-docs/style-guide#alt-text)." Do not use videos that just show a task without explaining or elaborating on the procedure. Videos must be useful and relevant, which includes staying accurate over time.
+
+## Accessibility requirements
+
+These are the minimum requirements for a video to be included in the {% data variables.product.prodname_docs %}. If a video violates any of these requirements, it cannot be added to the docs.
+
+- No flashing or strobe effects
+- Must have closed captions. See "[Creating video captions](#creating-video-captions)" below for more information
+- No graphics overlap with where captions appear
+- Typography must be legible
+- Any overlays must have sufficient contrast ratios
+- Any text must be on the screen long enough to be read (the text should appear onscreen for longer than it takes to read it out loud twice)
+- Must have proofread descriptive transcripts for what happens scene-by-scene. See "[Creating video transcripts](#creating-video-transcripts)" below for more information
+- Videos do not autoplay
+
+### Creating video captions
+
+Videos must have human-generated captions before being added to the Docs site. You can use auto caption technology to help create the captions, but they must be proofread and edited for accuracy by a person. If the video hosting service has a native caption tool, like YouTube, you can use that tool to prepare captions or create a properly formatted `SRT` or `VTT` transcript file to upload with the video.
+
+Creating captions is part of the process of producing videos that can be accessed by more people, so the owner of a video being added to {% data variables.product.prodname_docs %} should provide captions.
+
+#### Guidelines for captions
+
+Where possible, captions should exactly match the words spoken in the video. Do not paraphrase or truncate captions, unless serious time constraints mean it would be difficult for someone to read the captions in the time given.
+
+Captions must be synchronized to appear at approximately the same time as the audio. Captions should always be timed to appear on screen at the moment the speaker begins talking. For fast speech, where it would be difficult to read captions timed precisely to the audio, you can extend the captions to stay on screen after the speech has finished.
+
+If a video has multiple speakers, identify the speakers in the captions. Do this by adding the speaker's name, or a descriptive name such as `Developer`, before the start of the sentence. For example: `Jimmy: Hello.`. You only need to do this when the speaker changes, not for every line of dialogue. If it's obvious from the visuals who is speaking, you do not need to identify the speaker.
+
+Captions must be one or two lines, and no more than 32 characters per line. Put each new sentence on a new line. If you need to break a line mid-sentence, do so at a logical point, for example after commas or before conjunctions like `and` or `but`.
+
+#### Adding and editing captions on YouTube
+
+For videos hosted on YouTube, see "[Add subtitles and captions](https://support.google.com/youtube/answer/2734796?hl=en&ref_topic=7296214)" and "[Edit or remove captions](https://support.google.com/youtube/answer/2734705?hl=en&ref_topic=7296214)" in the YouTube docs.
+
+### Creating video transcripts
+
+For every video linked or embedded in the docs, we must have a descriptive transcript of the video. Transcript articles are formatted like other articles, with YAML frontmatter and Markdown content. To add a transcript to the Docs site, create an article in [`content/video-transcripts`](https://github.com/github/docs/tree/main/content/video-transcripts), and include the transcript as the article's body text. Give the article a filename like `transcript-VIDEO-NAME.md` and a `title` frontmatter property of `Transcript - VIDEO NAME`. Add the article to the `index.md` file in the `video-transcripts` directory.
+
+Do not use Liquid variables or reusables to replace things like product names in the transcript. The transcript should be faithful to the audio in the video, and we should not change any text in the transcript as a result of updating a variable or reusable after the video was produced.
+
+Creating transcripts is part of the process of producing videos that can be accessed by more people, so the owner of a video being added to the docs site should provide the content for a transcript.
+
+You can use captions as the foundation for a transcript. Edit the captions to remove any timestamps and include the relevant information detailed below. A descriptive transcript includes a text version of both audio and visual information needed to understand the content of a video.
+
+- If a video has multiple speakers, identify the speakers in the transcript
+- Format the transcript in logical paragraphs, lists, and sections. If it helps people understand the content, you may add headers to sections. Consider how someone would get information from the transcript if they are not also viewing the video
+- Add any onscreen text, relevant visual elements, or non-speech sounds that are not included in the captions. Place these descriptions after the spoken text that accompanies them in the video. Format visual information in brackets. For example, `[Background music plays. The narrator clicks the Code button and then the "+ New codespace" button.]`
+- Add a `product_video` property to the transcript article's YAML frontmatter. The value of the `product_video` property is the YouTube URL of the video. The video's YouTube URL will display as an external link in the transcript article
+- At the end of the transcript, link to the landing page for the product the video is about using the pattern `For more information about PRODUCT, see the ["Product" documentation](link/to/landing-page).`
+
+See "[Text Transcript with Description of Visuals](https://www.w3.org/WAI/perspective-videos/captions/#transcript)" in the W3C docs for more examples of audio and visual transcriptions.
+
+#### Linking to transcripts from externally hosted videos
+
+Add a link to the article with a video's transcript in the description of the video on the platform where it is hosted. For more information, see "[Edit video settings](https://support.google.com/youtube/answer/57404?)" in the YouTube documentation.
+
+#### Linking to transcripts for embedded videos
+
+In any content with an embedded video, add a `product_video_transcript` property below the `product_video` property in the YAML frontmatter. The value of `product_video_transcript` is a link to the transcript article in the `video-transcripts` directory.
+
+```YAML
+title: Example product landing page
+product_video: 'https://www.youtube-nocookie.com/embed/URL'
+product_video_transcript: /content/video-transcripts/TRANSCRIPT-TITLE
+```
+
+## Titles for videos
+
+Titles should be descriptive and follow the guidelines for titles in "[AUTOTITLE](/contributing/writing-for-github-docs/content-model#titles)."
+
+## Versioning
+
+If a video is only relevant for specific {% data variables.product.prodname_dotcom %} products (Free, Pro and Team; {% data variables.product.prodname_ghe_server %}; {% data variables.product.prodname_ghe_managed %}; and {% data variables.product.prodname_ghe_cloud %}), the video must be versioned for those products. Use [Liquid](https://github.com/github/docs/blob/main/contributing/liquid-helpers.md) conditional statements to version the videos appropriately. The Liquid conditional versioning may need to be added when the content is initially created, or may need to be added when the content is updated for a feature update or {% data variables.product.prodname_enterprise %} release.
+
+## Video hosting
+
+Videos must be hosted somewhere that {% data variables.product.prodname_dotcom %} owns and can grant the Docs team access to. Videos should not track users or use cookies. Currently, {% data variables.product.prodname_dotcom %}'s videos are hosted on YouTube and added to the docs using the [Privacy Enhanced Mode](https://support.google.com/youtube/answer/171780?hl=en#zippy=%2Cturn-on-privacy-enhanced-mode) by changing the domain for the embedded URL from `https://www.youtube.com/VIDEO` to `https://www.youtube-nocookie.com/VIDEO`.
diff --git a/content/contributing/writing-for-github-docs/writing-content-to-be-translated.md b/content/contributing/writing-for-github-docs/writing-content-to-be-translated.md
new file mode 100644
index 0000000000..b62e619b08
--- /dev/null
+++ b/content/contributing/writing-for-github-docs/writing-content-to-be-translated.md
@@ -0,0 +1,77 @@
+---
+title: Writing content to be translated
+shortTitle: Write content to be translated
+intro: 'Our documentation is translated into multiple languages. How we approach writing the English language documentation can greatly improve the quality of those translations.'
+product: '{% data reusables.contributing.product-note %}'
+versions:
+ feature: 'contributing'
+---
+
+## About writing content that is translation-friendly
+
+Use the following guidelines to ensure the content you create can be successfully translated. For more information, see "[Style guide](/contributing/writing-for-github-docs/style-guide)."
+
+- Use examples that are generic and can be understood by most people.
+- Avoid examples that are controversial or culturally specific to a group.
+- Write in active voice.
+- Write simple, short, and easy-to-understand sentences.
+- Avoid using too many pronouns that can make text unclear.
+- Avoid using slang and jokes.
+- Avoid negative sentences.
+- Use industry-standard acronyms whenever possible and explain custom acronyms.
+- Use indicative mood.
+- Eliminate redundant and wordy expressions.
+- Avoid the excessive use of stacked modifiers (noun strings). The translator can misunderstand which noun is the one being modified.
+- Avoid invisible plurals in which it is not clear if the first noun is meant to be singular or plural.
+- Avoid nominalization.
+- Avoid using ambiguous modal auxiliary verbs.
+- Avoid gender-specific words.
+- Avoid prepositional phrases.
+- Avoid vague nouns and pronouns (vague sentence subject).
+- Keep inline links to a minimum. If they are necessary, preface them with a phrase such as "For more information, see "Link title." Alternatively, add relevant links to a "Further reading" section at the end of the topic.
+
+## Examples
+
+This section provides examples for how to follow our guidelines for writing translation-friendly documentation.
+
+### Avoid country specific information
+
+For example, avoid 800 numbers and country specific addresses. If necessary, mention what countries the information applies to.
+
+### Avoid the excessive use of stacked modifiers (noun strings)
+
+Lots of stacked modifiers can lead to incorrect translations because it's not easy to determine what modifies what. For example, use "Default source settings for the public repository" instead of "public repository default source settings."
+
+### Avoid invisible plurals
+
+For example, when using the term "file retrieval," it's unclear if you are retrieving one file or all files. Provide more context to eliminate ambiguity. In the example given, you can use "retrieving all the files" or "retrieving the source.md file."
+
+### Avoid nominalization
+
+For example, instead of "to reach a conclusion," use "conclude."
+
+### Avoid using ambiguous modal auxiliary verbs.
+
+Avoid using words such as "may" and "might." Be more clear to avoid ambiguity.
+
+### Avoid prepositional phrases
+
+Instead of writing "after trying many times" or "according to the repository log," write more directly. For example, "after trying three times."
+
+### Avoid vague nouns and pronouns
+
+Vague nouns and pronouns can make it unclear who or what you are referring to, especially when that content has to be translated. For example, "Maintainers and contributors have access to files and comments. In the pull request they make changes to it." In this sentence, it is not clear if the changes are being made to the file or comments. If a pronoun seems to refer to more than one antecedent, either reword the sentence to make the antecedent clear or replace the pronoun with a noun to eliminate ambiguity.
+
+### Keep inline links to a minimum.
+
+Where possible, clearly introduce links following our style guide. For example, instead of the following sentence:
+
+```markdown
+Read [more about OAuth2.](/apps/building-integrations/setting-up-and-registering-oauth-apps/) Note that OAuth2 tokens can be [acquired programmatically](/rest/reference/oauth-authorizations/#create-a-new-authorization), for applications that are not websites.
+```
+
+You can use this instead:
+
+```markdown
+OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see "[Setting up and registering OAuth Apps](apps/building-integrations/setting-up-and-registering-oauth-apps/)" and "[Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization)."
+```
diff --git a/content/copilot/getting-started-with-github-copilot.md b/content/copilot/getting-started-with-github-copilot.md
index 7d63416cc2..f397b8c43d 100644
--- a/content/copilot/getting-started-with-github-copilot.md
+++ b/content/copilot/getting-started-with-github-copilot.md
@@ -266,6 +266,9 @@ To use {% data variables.product.prodname_copilot %}, you must first install the
1. If you have not previously authorized {% data variables.product.prodname_vscode %} in your {% data variables.product.prodname_dotcom %} account, you will be prompted to sign in to {% data variables.product.prodname_dotcom %} in {% data variables.product.prodname_vscode %}.
- If you have previously authorized {% data variables.product.prodname_vscode %} for your account on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_copilot %} will be automatically authorized.
+ - If you don't get the prompt to authorize, click the bell icon in the bottom panel of the {% data variables.product.prodname_vscode %} window.
+
+ 
1. In your browser, {% data variables.product.prodname_dotcom %} will request the necessary permissions for {% data variables.product.prodname_copilot %}. To approve these permissions, click **Authorize {% data variables.product.prodname_vscode %}**.
1. To confirm the authentication, in {% data variables.product.prodname_vscode %}, in the "{% data variables.product.prodname_vscode %}" dialog box, click **Open**.
diff --git a/content/index.md b/content/index.md
index bf8aae1e5c..a8d9cd82ee 100644
--- a/content/index.md
+++ b/content/index.md
@@ -76,6 +76,7 @@ children:
- early-access
- support
- video-transcripts
+ - contributing
childGroups:
- name: Get started
octicon: RocketIcon
diff --git a/content/issues/managing-your-tasks-with-tasklists/creating-a-tasklist.md b/content/issues/managing-your-tasks-with-tasklists/creating-a-tasklist.md
index 859d92adb2..48373f85d1 100644
--- a/content/issues/managing-your-tasks-with-tasklists/creating-a-tasklist.md
+++ b/content/issues/managing-your-tasks-with-tasklists/creating-a-tasklist.md
@@ -20,14 +20,14 @@ You can use the **Add tasklist** button to quickly add a tasklist to your issue.
1. Navigate to the issue you want to contain your new tasklist. You can also create a new issue.
1. At the bottom of the issue description, click {% octicon "plus" aria-hidden="true" %} **Add tasklist**.
-
+
-
+
1. You can then add issues, pull requests, and draft tasks to your new tasklist. For more information, see "[AUTOTITLE](/issues/managing-your-tasks-with-tasklists/managing-tasks-in-a-tasklist)."
## Creating tasklists with Markdown
-You can create tasklists using Markdown in the issue description (the opening comment of an issue). You can include links to issues and pull requests or create draft issues.
+You can create tasklists using Markdown in the issue description (the opening comment of an issue). You can include links to issues and pull requests or create draft issues.
You can add a tasklist by copying the Markdown below into your issue description:
@@ -47,7 +47,7 @@ Once you have started editing your tasklist Markdown, you can add new tasks by p
* A draft task. Draft tasks are text that can later be converted into issues.
* The full link to an issue or pull request or, if the issue or pull request is in the same repository as your tasklist, you can use the #ISSUE-NUMBER shorthand syntax. For example, `https://github.com/octo-org/octo-repo/issues/45` or `#45`.
-* If an issue or pull request is in the same repository
+* If an issue or pull request is in the same repository
If you add a draft task, it must meet these requirements:
@@ -58,7 +58,7 @@ Your tasklist will be rendered by {% data variables.product.product_name %} when
## Changing the title of a tasklist
-When you create a new tasklist, the default title is "Tasks." You can modify the title by clicking {% octicon "pencil" aria-hidden="true" %} **Rename** in the tasklist's context menu or by editing the issue's markdown.
+When you create a new tasklist, the default title is "Tasks." You can modify the title by clicking {% octicon "pencil" aria-hidden="true" %} **Rename** in the tasklist's context menu or by editing the issue's markdown.
1. In the top-right of the issue body, select {% octicon "kebab-horizontal" aria-label="Show options" %} and click **Edit**.
@@ -83,5 +83,3 @@ When you copy your tasklist using the "Copy Markdown" option, {% data variables.
1. In the menu, click **Copy markdown**.
-
-Your tasklist will be copied to your clipboard as a
diff --git a/content/organizations/managing-organization-settings/archiving-an-organization.md b/content/organizations/managing-organization-settings/archiving-an-organization.md
index d27e1a30d8..40bf199728 100644
--- a/content/organizations/managing-organization-settings/archiving-an-organization.md
+++ b/content/organizations/managing-organization-settings/archiving-an-organization.md
@@ -20,7 +20,7 @@ topics:
## About archiving your organization
-When you archive an organization, all repositories in the organization will be archived as well. This means that all issues, pull requests, and comments will be read-only. A key will be set in the API to indicate the organization has been archived. Many actions that can be performed in an organization will be disabled, including creating new repositories and deleting existing repositories. You will still be able to transfer repositories out of the organization, for example, to give a project to a user who is taking over active maintenance.
+When you archive an organization, all repositories in the organization will be archived as well. This means that all issues, pull requests, and comments will be read-only. A key will be set in the API to indicate the organization has been archived. Many actions that can be performed in an organization will be disabled, including creating new repositories. You will still be able to delete repositories. You will also still be able to transfer repositories out of the organization, for example, to give a project to a user who is taking over active maintenance.
When an organization is archived, visitors to the organization's profile will see a banner indicating that it has been archived. The repositories in the organization will now have a badge and a banner on their home page indicating that they are read-only.
diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md
index 7bfb0d4648..e60d6ea92e 100644
--- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md
+++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md
@@ -46,6 +46,7 @@ License | License keyword
| BSD 2-clause "Simplified" license | `bsd-2-clause` |
| BSD 3-clause "New" or "Revised" license | `bsd-3-clause` |
| BSD 3-clause Clear license | `bsd-3-clause-clear` |
+| BSD 4-clause "Original" or "Old" license | `bsd-4-clause` |
| BSD Zero-Clause license | `0bsd` |
| Creative Commons license family | `cc` |
| Creative Commons Zero v1.0 Universal | `cc0-1.0` |
diff --git a/contributing/videos-in-docs.md b/contributing/videos-in-docs.md
new file mode 100644
index 0000000000..5b1651ba44
--- /dev/null
+++ b/contributing/videos-in-docs.md
@@ -0,0 +1,38 @@
+# Videos in GitHub Docs
+
+This file tracks metadata for videos embedded in GitHub Docs.
+
+Add the following metadata for every video added docs.
+
+```markdown{:copy}
+Title: Video title
+URL: YouTube.com/
+Description: One sentence
+Product: e.x. Projects
+Versions: e.x. fpt, GHES > 3.2
+Date added: YYYY-MM-DD
+Location: /where/in/docs
+Transcript: ./content/video-transcripts/filename
+```
+
+```
+Title: Codespaces - Your instant dev box in the cloud
+URL: https://www.youtube-nocookie.com/embed/_W9B7qc9lVc
+Description: A 1.5 minute overview of GitHub Codespaces.
+Product: Codespaces
+Versions: fpt, ghec
+Date added: 2021-05-11
+Location: /content/codespaces/index.md
+Transcript: /video-transcripts/transcript-codespaces-your-instant-dev-box-in-the-cloud
+```
+
+```
+Title: Using Projects for feature planning
+URL: https://www.youtube-nocookie.com/embed/yFQ-p6wMS_Y
+Description: Check out all the cool new things you can do with your GitHub Projects powered by GitHub Issues
+Product: Issues, Projects
+Versions: projects-v2
+Date added: 2023-05-09
+Location: /content/issues/index.md
+Transcript: /video-transcripts/transcript-using-projects-for-feature-planning
+```
diff --git a/data/features/contributing.yml b/data/features/contributing.yml
new file mode 100644
index 0000000000..bbda38023b
--- /dev/null
+++ b/data/features/contributing.yml
@@ -0,0 +1,6 @@
+# Contributing to GitHub Docs (how we docs)
+versions:
+ fpt: '*'
+ ghec: '*'
+ ghes: '*'
+ ghae: '*'
diff --git a/data/release-notes/enterprise-server/3-6/0.yml b/data/release-notes/enterprise-server/3-6/0.yml
index 98bb189f4c..a09a907c34 100644
--- a/data/release-notes/enterprise-server/3-6/0.yml
+++ b/data/release-notes/enterprise-server/3-6/0.yml
@@ -311,6 +311,7 @@ sections:
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
deprecations:
- heading: Changes to supported SSH algorithms
diff --git a/data/release-notes/enterprise-server/3-6/1.yml b/data/release-notes/enterprise-server/3-6/1.yml
index 4860c9b5fd..a8c1021d11 100644
--- a/data/release-notes/enterprise-server/3-6/1.yml
+++ b/data/release-notes/enterprise-server/3-6/1.yml
@@ -37,4 +37,5 @@ sections:
GitHub Pages builds may time out on instances in AWS that are configured for high availability. [Updated: 2022-11-28]
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/10.yml b/data/release-notes/enterprise-server/3-6/10.yml
index 21aa51fe57..fd3cfe5e7c 100644
--- a/data/release-notes/enterprise-server/3-6/10.yml
+++ b/data/release-notes/enterprise-server/3-6/10.yml
@@ -24,4 +24,5 @@ sections:
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.stuck-discussion-conversion-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/11.yml b/data/release-notes/enterprise-server/3-6/11.yml
index 9a31289dc3..f913c93fdc 100644
--- a/data/release-notes/enterprise-server/3-6/11.yml
+++ b/data/release-notes/enterprise-server/3-6/11.yml
@@ -51,3 +51,4 @@ sections:
- |
{% data reusables.release-notes.repository-inconsistencies-errors %}
- '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
diff --git a/data/release-notes/enterprise-server/3-6/12.yml b/data/release-notes/enterprise-server/3-6/12.yml
index 31d70a29f8..a0b418b815 100644
--- a/data/release-notes/enterprise-server/3-6/12.yml
+++ b/data/release-notes/enterprise-server/3-6/12.yml
@@ -24,3 +24,4 @@ sections:
- |
{% data reusables.release-notes.repository-inconsistencies-errors %}
- '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/13.yml b/data/release-notes/enterprise-server/3-6/13.yml
index 1b84aad712..be38288a3c 100644
--- a/data/release-notes/enterprise-server/3-6/13.yml
+++ b/data/release-notes/enterprise-server/3-6/13.yml
@@ -46,3 +46,4 @@ sections:
# https://github.com/github/driftwood/issues/2746
- |
On an instance with audit log streaming enabled, the `driftwood` service does not start, preventing the normal operation of audit log streaming. [Updated: 2023-06-06]
+ - '{% data reusables.release-notes.user-already-taken %}'
diff --git a/data/release-notes/enterprise-server/3-6/14.yml b/data/release-notes/enterprise-server/3-6/14.yml
index e9341135a0..73bf35c3a6 100644
--- a/data/release-notes/enterprise-server/3-6/14.yml
+++ b/data/release-notes/enterprise-server/3-6/14.yml
@@ -36,3 +36,4 @@ sections:
- |
When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
- '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue-updated %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/15.yml b/data/release-notes/enterprise-server/3-6/15.yml
index 8625d9fa70..b7303f0c98 100644
--- a/data/release-notes/enterprise-server/3-6/15.yml
+++ b/data/release-notes/enterprise-server/3-6/15.yml
@@ -35,3 +35,4 @@ sections:
If an instance is configured to forward logs to a target server with TLS enabled, certificate authority (CA) bundles that a site administrator uploads using `ghe-ssl-ca-certificate-install` are not respected, and connections to the server fail.
- |
When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/16.yml b/data/release-notes/enterprise-server/3-6/16.yml
new file mode 100644
index 0000000000..5cf8d485a9
--- /dev/null
+++ b/data/release-notes/enterprise-server/3-6/16.yml
@@ -0,0 +1,56 @@
+date: '2023-07-18'
+sections:
+ security_fixes:
+ - |
+ An attacker with access to the password hash of the root site administrator user for the instance's Management Console could make requests to the password API endpoint from outside of the instance.
+ - |
+ Packages have been updated to the latest security versions.
+ bugs:
+ - |
+ Customers who use Azure Blob store as the remote blob provider to back GitHub Packages would have validation errors if the `EndpointSuffix` part of their Connection string was anything other than `core.windows.net`. Now all valid `EndpointSuffix` are accepted.
+ - |
+ After creation of a blob object from the web UI, pre-receive hook events were missing from the instance's audit log.
+ - |
+ On an instance with an outbound web proxy server configured, the proxy interfered with internal operations that used `nomad alloc exec`.
+ - |
+ On an instance in a cluster configuration, the `ghe-cluster-balance` behaved inconsistently when displaying status or managing jobs with more than one task group.
+ - |
+ On an instance configured for LDAP authentication, if the LDAP server sent an empty string for the `sshPublicKey` attribute, LDAP user sync would fail.
+ - |
+ On an instance with Dependabot enabled, in some situations, Dependabot alerts were not updated when a user pushed to a repository.
+ - |
+ On an instance that was not configured to deliver email notifications using SMTP, background jobs to deliver email were enqueued unnecessarily.
+ - |
+ Determining suggested reviewers on a pull request could time out or be very slow.
+ - |
+ In some cases, users could reopen a pull request that should not have been able to be reopened.
+ - |
+ On an instance with a GitHub Advanced Security license and secret scanning enabled, output from Git for a push blocked by push protection always included an `http://` link.
+ changes:
+ - |
+ On an instance in a cluster configuration, the `ghe-cluster-config-check` command-line utility will return an affirmative message when no warnings or errors are detected. The affirmative message is "Configuration validation complete. No errors found."
+ - |
+ On an instance with 170 or fewer vCPUs, the default for `app.babeld.threads-max` is 512 instead of 3 times the number of vCPUs. The monitor dashboard also includes metrics within the "Babeld threads" section.
+ - |
+ The Management Console displays a warning about unexpected consequences that may result from modification of the instance's hostname after initial configuration.
+ known_issues:
+ - |
+ Custom firewall rules are removed during the upgrade process.
+ - |
+ Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.
+ - |
+ The GitHub Packages npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
+ - |
+ {% data reusables.release-notes.babeld-max-threads-performance-issue %}
+ - |
+ In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality.
+ - |
+ Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter.
+ - |
+ {% data reusables.release-notes.repository-inconsistencies-errors %}
+ - |
+ On an instance in a high-availability configuration, passive replica nodes accept Git client requests and forward the requests to the primary node.
+ - |
+ If an instance is configured to forward logs to a target server with TLS enabled, certificate authority (CA) bundles that a site administrator uploads using `ghe-ssl-ca-certificate-install` are not respected, and connections to the server fail.
+ - |
+ When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
diff --git a/data/release-notes/enterprise-server/3-6/2.yml b/data/release-notes/enterprise-server/3-6/2.yml
index dae79e183a..7c1b45fe13 100644
--- a/data/release-notes/enterprise-server/3-6/2.yml
+++ b/data/release-notes/enterprise-server/3-6/2.yml
@@ -48,4 +48,5 @@ sections:
GitHub Pages builds may time out on instances in AWS that are configured for high availability. [Updated: 2022-11-28]
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/3.yml b/data/release-notes/enterprise-server/3-6/3.yml
index 588e8d67a9..a07d9b395a 100644
--- a/data/release-notes/enterprise-server/3-6/3.yml
+++ b/data/release-notes/enterprise-server/3-6/3.yml
@@ -56,4 +56,5 @@ sections:
GitHub Pages builds may time out on instances in AWS that are configured for high availability. [Updated: 2022-11-28]
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/4.yml b/data/release-notes/enterprise-server/3-6/4.yml
index 6ac0d6774a..09ca7d8ea2 100644
--- a/data/release-notes/enterprise-server/3-6/4.yml
+++ b/data/release-notes/enterprise-server/3-6/4.yml
@@ -38,4 +38,5 @@ sections:
- '{% data reusables.release-notes.repository-inconsistencies-errors %}'
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/5.yml b/data/release-notes/enterprise-server/3-6/5.yml
index bef81aafa4..e1175ba89b 100644
--- a/data/release-notes/enterprise-server/3-6/5.yml
+++ b/data/release-notes/enterprise-server/3-6/5.yml
@@ -41,4 +41,5 @@ sections:
- '{% data reusables.release-notes.repository-inconsistencies-errors %}'
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/6.yml b/data/release-notes/enterprise-server/3-6/6.yml
index 61f7013707..659ce5d5b9 100644
--- a/data/release-notes/enterprise-server/3-6/6.yml
+++ b/data/release-notes/enterprise-server/3-6/6.yml
@@ -35,4 +35,5 @@ sections:
- '{% data reusables.release-notes.repository-inconsistencies-errors %}'
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/7.yml b/data/release-notes/enterprise-server/3-6/7.yml
index 17af0e5a0d..0d94c64fec 100644
--- a/data/release-notes/enterprise-server/3-6/7.yml
+++ b/data/release-notes/enterprise-server/3-6/7.yml
@@ -19,4 +19,5 @@ sections:
- '{% data reusables.release-notes.repository-inconsistencies-errors %}'
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/8.yml b/data/release-notes/enterprise-server/3-6/8.yml
index 10cf05c373..aeb442c8e5 100644
--- a/data/release-notes/enterprise-server/3-6/8.yml
+++ b/data/release-notes/enterprise-server/3-6/8.yml
@@ -25,4 +25,5 @@ sections:
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.stuck-discussion-conversion-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-6/9.yml b/data/release-notes/enterprise-server/3-6/9.yml
index 55265d87ea..32041ed663 100644
--- a/data/release-notes/enterprise-server/3-6/9.yml
+++ b/data/release-notes/enterprise-server/3-6/9.yml
@@ -23,4 +23,5 @@ sections:
- '{% data reusables.release-notes.babeld-max-threads-performance-issue %}'
- '{% data reusables.release-notes.stuck-discussion-conversion-issue %}'
- '{% data reusables.release-notes.git-push-known-issue %}'
- - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue %}'
+ - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-7/13.yml b/data/release-notes/enterprise-server/3-7/13.yml
new file mode 100644
index 0000000000..ad2a231300
--- /dev/null
+++ b/data/release-notes/enterprise-server/3-7/13.yml
@@ -0,0 +1,78 @@
+date: '2023-07-18'
+sections:
+ security_fixes:
+ - |
+ An attacker with access to the password hash of the root site administrator user for the instance's Management Console could make requests to the password API endpoint from outside of the instance.
+ - |
+ Packages have been updated to the latest security versions.
+ bugs:
+ - |
+ If MinIO was configured for external blob storage on an instance with GitHub Actions enabled and MinIO was configured for bucket replication, the instance's credential validation with MinIO would occasionally fail.
+ - |
+ Customers who use Azure Blob store as the remote blob provider to back GitHub Packages would have validation errors if the `EndpointSuffix` part of their Connection string was anything other than `core.windows.net`. Now all valid `EndpointSuffix` are accepted.
+ - |
+ After creation of a blob object from the web UI, pre-receive hook events were missing from the instance's audit log.
+ - |
+ On an instance with custom firewall rules defined, a configuration run with `ghe-config-apply` could take longer than expected.
+ - |
+ On an instance with an outbound web proxy server configured, the proxy interfered with internal operations that used `nomad alloc exec`.
+ - |
+ On an instance in a cluster configuration, the `ghe-cluster-balance` behaved inconsistently when displaying status or managing jobs with more than one task group.
+ - |
+ On an instance configured for LDAP authentication, if the LDAP server sent an empty string for the `sshPublicKey` attribute, LDAP user sync would fail.
+ - |
+ When an administrator updated an instance's TLS certificate via the API as a query parameter instead of in the request body, the certificate and key appeared in `unicorn.log`.
+ - |
+ On an instance with Dependabot enabled, in some situations, Dependabot alerts were not updated when a user pushed to a repository.
+ - |
+ Determining suggested reviewers on a pull request could time out or be very slow.
+ - |
+ After a migration using GitHub Enterprise Importer, some repository autolink references were created with an incorrect format.
+ - |
+ On an instance that was not configured to deliver email notifications using SMTP, background jobs to deliver email were enqueued unnecessarily.
+ - |
+ Events related to repository notifications did not appear in the audit log.
+ - |
+ On an instance with a GitHub Advanced Security license and secret scanning enabled, in some cases, a committer would not receive an email notification for a secret scanning alert where push protections were bypassed.
+ - |
+ In some cases, users could reopen a pull request that should not have been able to be reopened.
+ - |
+ On an instance with a GitHub Advanced Security license, if a user filtered by a custom pattern on an organizations "Code & security analysis" page using an invalid query, the entire GitHub Advanced Security disappeared and an error reading "Sorry, something went wrong loading GitHub Advanced Security settings" appeared.
+ - |
+ On an instance with a GitHub Advanced Security license and secret scanning enabled, output from Git for a push blocked by push protection always included an `http://` link.
+ - |
+ The audit log reported the incorrect target repository for pre-receive hook failures.
+ - |
+ On an instance in a high availability configuration, existing nodes with out-of-sync repositories prevented new nodes from replicating those repositories.
+ - |
+ On an instance with multiple nodes, when using the `spokesctl` command-line utility to manage repositories with replicas that failed to fully create, the utility would spuriously attempt to repair healthy replicas.
+ changes:
+ - |
+ On an instance in a cluster configuration, the `ghe-cluster-config-check` command-line utility will return an affirmative message when no warnings or errors are detected. The affirmative message is "Configuration validation complete. No errors found."
+ - |
+ During initialization of a cluster configuration, output from the `ghe-cluster-config-init` command-line utility is improved and simplified.
+ - |
+ On an instance with 170 or fewer vCPUs, the default for `app.babeld.threads-max` is 512 instead of 3 times the number of vCPUs. The monitor dashboard also includes metrics within the "Babeld threads" section.
+ - |
+ The Management Console displays a warning about unexpected consequences that may result from modification of the instance's hostname after initial configuration.
+ known_issues:
+ - |
+ Custom firewall rules are removed during the upgrade process.
+ - |
+ The GitHub Packages npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
+ - |
+ {% data reusables.release-notes.babeld-max-threads-performance-issue %}
+ - |
+ In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality.
+ - |
+ {% data reusables.release-notes.repository-inconsistencies-errors %}
+ - |
+ During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start.
+ - |
+ On an instance in a high-availability configuration, passive replica nodes accept Git client requests and forward the requests to the primary node.
+ - |
+ If an instance is configured to forward logs to a target server with TLS enabled, certificate authority (CA) bundles that a site administrator uploads using `ghe-ssl-ca-certificate-install` are not respected, and connections to the server fail.
+ - |
+ When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
+ - |
+ {% data reusables.release-notes.enterprise-backup-utils-encryption-keys %}
diff --git a/data/release-notes/enterprise-server/3-8/6.yml b/data/release-notes/enterprise-server/3-8/6.yml
new file mode 100644
index 0000000000..b1bed9ba84
--- /dev/null
+++ b/data/release-notes/enterprise-server/3-8/6.yml
@@ -0,0 +1,98 @@
+date: '2023-07-18'
+sections:
+ security_fixes:
+ - |
+ An attacker with access to the password hash of the root site administrator user for the instance's Management Console could make requests to the password API endpoint from outside of the instance.
+ - |
+ Packages have been updated to the latest security versions.
+ bugs:
+ - |
+ If MinIO was configured for external blob storage on an instance with GitHub Actions enabled and MinIO was configured for bucket replication, the instance's credential validation with MinIO would occasionally fail.
+ - |
+ Customers who use Azure Blob store as the remote blob provider to back GitHub Packages would have validation errors if the `EndpointSuffix` part of their Connection string was anything other than `core.windows.net`. Now all valid `EndpointSuffix` are accepted.
+ - |
+ When a user viewed a Jupyter notebook, GitHub Enterprise Server returned a `500` error code if the instance was configured with a self-signed TLS certificate.
+ - |
+ After creation of a blob object from the web UI, pre-receive hook events were missing from the instance's audit log.
+ - |
+ On an instance in a high availability configuration, on some platforms, replication could perform poorly over links with very high latency.
+ - |
+ On an instance with custom firewall rules defined, a configuration run with `ghe-config-apply` could take longer than expected.
+ - |
+ On an instance with an outbound web proxy server configured, the proxy interfered with internal operations that used `nomad alloc exec`.
+ - |
+ On an instance in a cluster configuration, the `ghe-cluster-balance` behaved inconsistently when displaying status or managing jobs with more than one task group.
+ - |
+ On an instance configured for LDAP authentication, if the LDAP server sent an empty string for the `sshPublicKey` attribute, LDAP user sync would fail.
+ - |
+ When an administrator updated an instance's TLS certificate via the API as a query parameter instead of in the request body, the certificate and key appeared in `unicorn.log`.
+ - |
+ Jobs that performed daily clean-up tasks failed to run, so old data was not removed from the MySQL database.
+ - |
+ After creation of a new Management Console user, the Management Console did not display the button to copy the new users invitation.
+ - |
+ `ghe-service-list` erroneously reported errors because the utility looked for systemd services that have been migrated to Nomad.
+ - |
+ On an instance in a high availability configuration, when adding a new node, connection checks between existing nodes would fail.
+ - |
+ On an instance with Dependabot enabled, in some situations, Dependabot alerts were not updated when a user pushed to a repository.
+ - |
+ In rare circumstances, Git commits signed with SSH keys using the RSA algorithm would incorrectly indicate the signature was invalid.
+ - |
+ After a migration using GitHub Enterprise Importer, some repository autolink references were created with an incorrect format.
+ - |
+ In some cases on an instance without a GitHub Advanced Security license, Redis exceeded the maximum default memory allocation, causing `500` errors for the instance's users.
+ - |
+ On an instance with many organizations, the enterprise security overview page returned a `500` error.
+ - |
+ On an instance that was not configured to deliver email notifications using SMTP, background jobs to deliver email were enqueued unnecessarily.
+ - |
+ Users were unable to configure a SSH certificate authority for an organization.
+ - |
+ An erroneous "Blocked Copilot Repositories" link was visible in site admin pages for organizations.
+ - |
+ Events related to repository notifications did not appear in the audit log.
+ - |
+ On an instance with a GitHub Advanced Security license and secret scanning enabled, in some cases, a committer would not receive an email notification for a secret scanning alert where push protections were bypassed.
+ - |
+ On an instance with a GitHub Advanced Security license, if a user filtered by a custom pattern on an organizations "Code & security analysis" page using an invalid query, the entire GitHub Advanced Security disappeared and an error reading "Sorry, something went wrong loading GitHub Advanced Security settings" appeared.
+ - |
+ In some cases, users could reopen a pull request that should not have been able to be reopened.
+ - |
+ On an instance with a GitHub Advanced Security license and secret scanning enabled, output from Git for a push blocked by push protection always included an `http://` link.
+ - |
+ Querying the audit log for `hashed_token` returned no results.
+ - |
+ The audit log reported the incorrect target repository for pre-receive hook failures.
+ - |
+ Links to wiki pages in Markdown headers did not point to the correct path, resulting in a `404 Not Found` error.
+ - |
+ GitHub Actions will now properly execute after restoring a deleted repository.
+ - |
+ On an instance with multiple nodes, when using the `spokesctl` command-line utility to manage repositories with replicas that failed to fully create, the utility would spuriously attempt to repair healthy replicas.
+ changes:
+ - |
+ On an instance in a cluster configuration, the `ghe-cluster-config-check` command-line utility will return an affirmative message when no warnings or errors are detected. The affirmative message is "Configuration validation complete. No errors found."
+ - |
+ During initialization of a cluster configuration, output from the `ghe-cluster-config-init` command-line utility is improved and simplified.
+ - |
+ The Management Console displays a warning about unexpected consequences that may result from modification of the instance's hostname after initial configuration.
+ known_issues:
+ - |
+ Custom firewall rules are removed during the upgrade process.
+ - |
+ The GitHub Packages npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
+ - |
+ During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start.
+ - |
+ If the root site administrator is locked out of the Management Console after failed login attempts, the account will not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[Troubleshooting access to the Management Console](https://docs.github.com/en/enterprise-server@3.8/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)." [Updated: 2023-02-23]
+ - |
+ On an instance in a high-availability configuration, passive replica nodes accept Git client requests and forward the requests to the primary node.
+ - |
+ If an instance is configured to forward logs to a target server with TLS enabled, certificate authority (CA) bundles that a site administrator uploads using `ghe-ssl-ca-certificate-install` are not respected, and connections to the server fail.
+ - |
+ When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
+ - |
+ On an instance with subdomain isolation disabled, Mermaid diagrams in the web UI display an "Unable to render rich display" error and fail to render.
+ - |
+ {% data reusables.release-notes.enterprise-backup-utils-encryption-keys %}
diff --git a/data/release-notes/enterprise-server/3-9/1.yml b/data/release-notes/enterprise-server/3-9/1.yml
new file mode 100644
index 0000000000..81338271c1
--- /dev/null
+++ b/data/release-notes/enterprise-server/3-9/1.yml
@@ -0,0 +1,100 @@
+date: '2023-07-18'
+sections:
+ security_fixes:
+ - |
+ An attacker with access to the password hash of the root site administrator user for the instance's Management Console could make requests to the password API endpoint from outside of the instance.
+ - |
+ Packages have been updated to the latest security versions.
+ bugs:
+ - |
+ In some cases, users could reopen a pull request that should not have been able to be reopened.
+ - |
+ If MinIO was configured for external blob storage on an instance with GitHub Actions enabled and MinIO was configured for bucket replication, the instance's credential validation with MinIO would occasionally fail.
+ - |
+ Customers who use Azure Blob store as the remote blob provider to back GitHub Packages would have validation errors if the `EndpointSuffix` part of their Connection string was anything other than `core.windows.net`. Now all valid `EndpointSuffix` are accepted.
+ - |
+ When a user viewed a Jupyter notebook, GitHub Enterprise Server returned a `500` error code if the instance was configured with a self-signed TLS certificate.
+ - |
+ After creation of a blob object from the web UI, pre-receive hook events were missing from the instance's audit log.
+ - |
+ On an instance with an outbound web proxy server configured, the proxy interfered with internal operations that used `nomad alloc exec`.
+ - |
+ On an instance in a cluster configuration, the `ghe-cluster-balance` behaved inconsistently when displaying status or managing jobs with more than one task group.
+ - |
+ `.topojson` files would not render correctly, but files that conformed to the TopoJSON spec that used a `.geojson` extension would render correctly.
+ - |
+ On an instance configured for LDAP authentication, if the LDAP server sent an empty string for the `sshPublicKey` attribute, LDAP user sync would fail.
+ - |
+ REST API endpoints for managing GitHub Enterprise Server are now functional. For more information, see "[Manage GitHub Enterprise Server](/rest/enterprise-admin/manage-ghes?apiVersion=2022-11-28)" in the REST API documentation.
+ - |
+ After creation of a new Management Console user, the Management Console did not display the button to copy the new users invitation.
+ - |
+ On an instance with Dependabot enabled, in some situations, Dependabot alerts were not updated when a user pushed to a repository.
+ - |
+ In some cases, pull requests with more than 25 rich-diff renderable files required that users toggle the diff type to correctly render the files over the 25-file limit.
+ - |
+ In rare circumstances, Git commits signed with SSH keys using the RSA algorithm would incorrectly indicate the signature was invalid.
+ - |
+ After a migration using GitHub Enterprise Importer, some repository autolink references were created with an incorrect format.
+ - |
+ In some cases on an instance without a GitHub Advanced Security license, Redis exceeded the maximum default memory allocation, causing `500` errors for the instance's users.
+ - |
+ On an instance with many organizations, the enterprise security overview page returned a `500` error.
+ - |
+ On an instance that was not configured to deliver email notifications using SMTP, background jobs to deliver email were enqueued unnecessarily.
+ - |
+ Users were unable to configure a SSH certificate authority for an organization.
+ - |
+ An erroneous "Blocked Copilot Repositories" link was visible in site admin pages for organizations.
+ - |
+ On an instance with GitHub Actions enabled and a GitHub Advanced Security license, repository-level runner scale sets were not accounted for when determining whether default setup for code scanning could be used.
+ - |
+ Events related to repository notifications did not appear in the audit log.
+ - |
+ On an instance with a GitHub Advanced Security license and secret scanning enabled, in some cases, a committer would not receive an email notification for a secret scanning alert where push protections were bypassed.
+ - |
+ On an instance with a GitHub Advanced Security license, if a user filtered by a custom pattern on an organizations "Code & security analysis" page using an invalid query, the entire GitHub Advanced Security disappeared and an error reading "Sorry, something went wrong loading GitHub Advanced Security settings" appeared.
+ - |
+ On an instance with a GitHub Advanced Security license, if a user browsed to the alerts page for secret scanning without signing in, the instance responded with a `500` error.
+ - |
+ On an instance with a GitHub Advanced Security license and secret scanning enabled, output from Git for a push blocked by push protection always included an `http://` link.
+ - |
+ On an instance with GitHub Actions enabled, links to `http(s)://HOSTNAME/features/actions` from the web UI returned a `500` error.
+ - |
+ If a user added a new item to a projects roadmap view, and the item was outside of the viewport, the view would crash and display "This project failed to load".
+ - |
+ The audit log reported the incorrect target repository for pre-receive hook failures.
+ - |
+ Users can add issues and pull requests from any organization to a project, and are no longer limited to the user or organization of the project.
+ - |
+ On an instance with GitHub Actions enabled and a GitHub Advanced Security license, enterprise-level runner scale sets with the `code-scanning` label were not sufficient to allow default setup for code scanning.
+ - |
+ On an instance in a high availability configuration, existing nodes with out-of-sync repositories prevented new nodes from replicating those repositories.
+ - |
+ On an instance with multiple nodes, `ERROR`-level "resolver failed" errors no longer appear in system logs when the instance is unable to resolve an offline fileserver. The messages are now `DEBUG`-level.
+ - |
+ On an instance with a GitHub Advanced Security license that was also configured for a timezone greater than UTC, the list of secret scanning alerts displayed a "Loading secrets failed" error if a user sorted secrets by date in descending order.
+ - |
+ Code Scanning workflow runs now only request the `code-scanning` label so that they can be used with runner scale sets.
+ - |
+ On an instance with subdomain isolation disabled, Mermaid diagrams in the web UI displayed an "Unable to render rich display" error and failed to render.
+ changes:
+ - |
+ On an instance in a cluster configuration, the `ghe-cluster-config-check` command-line utility will return an affirmative message when no warnings or errors are detected. The affirmative message is "Configuration validation complete. No errors found."
+ - |
+ During initialization of a cluster configuration, output from the `ghe-cluster-config-init` command-line utility is improved and simplified.
+ - |
+ The API endpoint for management of the GitHub Enterprise Server instance was unavailable prior to initial configuration of the instance.
+ - |
+ The Management Console displays a warning about unexpected consequences that may result from modification of the instance's hostname after initial configuration.
+ - |
+ On an instance with multiple nodes, internal tooling to repair repositories now attempts to resolve problems within the entire repository network.
+ known_issues:
+ - |
+ The `mbind: Operation not permitted` error in the `/var/log/mysql/mysql.err` file can be ignored. MySQL 8 does not gracefully handle when the `CAP_SYS_NICE` capability isn't required, and outputs an error instead of a warning.
+ - |
+ {% data reusables.release-notes.enterprise-backup-utils-encryption-keys %}
+ - |
+ {% data reusables.release-notes.manage-api-unreachable %}
+ - |
+ When enabling CodeQL via default setup [at scale](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale), some checks related to GitHub Actions are omitted, potentially preventing the process from completing.
diff --git a/data/reusables/code-scanning/what-is-codeql-cli.md b/data/reusables/code-scanning/what-is-codeql-cli.md
index 2d4e1c65b1..e0a0f2d154 100644
--- a/data/reusables/code-scanning/what-is-codeql-cli.md
+++ b/data/reusables/code-scanning/what-is-codeql-cli.md
@@ -1 +1 @@
-The {% data variables.product.prodname_codeql_cli %} is a standalone product that you can use to analyze code. Its main purpose is to generate a database representation of a codebase, a {% data variables.product.prodname_codeql %} database. Once the database is ready, you can query it interactively, or run a suite of queries to generate a set of results in SARIF format and upload the results to {% data variables.location.product_location %}.
+The {% data variables.product.prodname_codeql_cli %} is a standalone, command-line tool that you can use to analyze code. Its main purpose is to generate a database representation of a codebase, a {% data variables.product.prodname_codeql %} database. Once the database is ready, you can query it interactively, or run a suite of queries to generate a set of results in SARIF format and upload the results to {% data variables.location.product_location %}.
diff --git a/data/reusables/contributing/product-note.md b/data/reusables/contributing/product-note.md
new file mode 100644
index 0000000000..d3b39cc1b9
--- /dev/null
+++ b/data/reusables/contributing/product-note.md
@@ -0,0 +1 @@
+Articles in the "Contributing to GitHub Docs" section refer to the documentation itself and are a resource for GitHub staff and open source contributors.
\ No newline at end of file
diff --git a/data/reusables/dependabot/configuration-options.md b/data/reusables/dependabot/configuration-options.md
index 32abbc42cd..1020d02672 100644
--- a/data/reusables/dependabot/configuration-options.md
+++ b/data/reusables/dependabot/configuration-options.md
@@ -21,5 +21,5 @@
| [`schedule.time`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#scheduletime) | {% octicon "x" aria-label="Not supported" %}| {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Time of day to check for updates (hh:mm) |
| [`schedule.timezone`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#scheduletimezone) | {% octicon "x" aria-label="Not supported" %}| {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Timezone for time of day (zone identifier) |
| [`target-branch`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#target-branch) | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Branch to create pull requests against |
-| [`vendor`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#vendor) | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Update vendored or cached dependencies |
+| [`vendor`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#vendor) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Update vendored or cached dependencies |
| [`versioning-strategy`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#versioning-strategy) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | How to update manifest version requirements |
diff --git a/data/reusables/release-notes/user-already-taken.md b/data/reusables/release-notes/user-already-taken.md
new file mode 100644
index 0000000000..0747b526b3
--- /dev/null
+++ b/data/reusables/release-notes/user-already-taken.md
@@ -0,0 +1 @@
+On an instance configured for SAML authentication, when signing in, users may erroneously see an error indicating "User has already been taken." [Updated: 2023-07-18]
diff --git a/data/reusables/secret-scanning/push-protection-high-level.md b/data/reusables/secret-scanning/push-protection-high-level.md
new file mode 100644
index 0000000000..2754dcd237
--- /dev/null
+++ b/data/reusables/secret-scanning/push-protection-high-level.md
@@ -0,0 +1 @@
+You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret.
\ No newline at end of file
diff --git a/data/variables/product.yml b/data/variables/product.yml
index 846094c0f0..123ec6c62c 100644
--- a/data/variables/product.yml
+++ b/data/variables/product.yml
@@ -3,12 +3,13 @@
# Company
+# Use this variable when referring to the company in the context of its business. For example, in licensing agreements
company_short: 'GitHub'
# GitHub's flagship products
product_name: >-
{% ifversion ghec %}GitHub Enterprise Cloud{% elsif ghes %}GitHub Enterprise Server{% elsif ghae %}GitHub AE{% else %}GitHub{% endif %}
-## Use this variable when the output should always be GitHub, regardless of the product the user is using
+## Use this variable when referring to the product, when the output should always be GitHub. For example, "the GitHub REST API"
prodname_dotcom: 'GitHub'
## Use this variable when the output should always be GitHub Enterprise, regardless of the product the user is using
diff --git a/src/content-linter/tests/lint-files.js b/src/content-linter/tests/lint-files.js
index 915f339ba5..9647923403 100755
--- a/src/content-linter/tests/lint-files.js
+++ b/src/content-linter/tests/lint-files.js
@@ -463,6 +463,14 @@ describe('lint markdown content', () => {
})
test('placeholder string is not present in any markdown files', async () => {
+ // this article explains how to use todocs placeholder text so shouldn't fail this test
+ if (
+ markdownRelPath ===
+ 'content/contributing/collaborating-on-github-docs/using-the-todocs-placeholder-to-leave-notes.md' ||
+ markdownRelPath === 'content/contributing/collaborating-on-github-docs/index.md'
+ ) {
+ return
+ }
const matches = rawContent.match(placeholderRegex) || []
const placeholderStr = matches.length === 1 ? 'placeholder' : 'placeholders'
const errorMessage = `
diff --git a/src/content-linter/tests/site-data-references.js b/src/content-linter/tests/site-data-references.js
index dda5ff35c1..eaa3734c3a 100644
--- a/src/content-linter/tests/site-data-references.js
+++ b/src/content-linter/tests/site-data-references.js
@@ -20,8 +20,17 @@ const pages = await loadPages()
const getDataPathRegex =
/{%\s*?(?:data|indented_data_reference)\s+?(\S+?)\s*?(?:spaces=\d\d?\s*?)?%}/
+const rawLiquidPattern = /{%\s*raw\s*%}.*?{%\s*endraw\s*%}/gs
+
const getDataReferences = (content) => {
- const refs = content.match(patterns.dataReference) || []
+ // When looking for things like `{% data reusables.foo %}` in the
+ // content, we first have to exclude any Liquid that isn't real.
+ // E.g.
+ // {% raw %}
+ // Here's an example: {% data reusables.foo.bar %}
+ // {% endraw %}
+ const withoutRawLiquidBlocks = content.replace(rawLiquidPattern, '')
+ const refs = withoutRawLiquidBlocks.match(patterns.dataReference) || []
return refs.map((ref) => ref.replace(getDataPathRegex, '$1'))
}
diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
index 330246d1c2..fa4e992dec 100644
--- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
@@ -363,7 +363,7 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing",
+ "requestPath": "/orgs/{org}/copilot/billing",
"additional-permissions": [],
"access": "write"
},
@@ -372,7 +372,7 @@
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats",
+ "requestPath": "/orgs/{org}/copilot/billing/seats",
"additional-permissions": [],
"access": "write"
},
@@ -2182,6 +2182,15 @@
"additional-permissions": [],
"access": "write"
},
+ {
+ "category": "repos",
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
+ "additional-permissions": [],
+ "access": "write"
+ },
{
"category": "repos",
"slug": "enable-automated-security-fixes",
diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
index 6938ef834b..41886981fc 100644
--- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
@@ -1754,13 +1754,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing"
+ "requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats"
+ "requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -3770,6 +3770,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
+ {
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
+ },
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",
diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
index 473d4551a5..e85aecc227 100644
--- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
@@ -437,7 +437,7 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing",
+ "requestPath": "/orgs/{org}/copilot/billing",
"access": "write",
"user-to-server": true,
"server-to-server": true,
@@ -448,7 +448,7 @@
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats",
+ "requestPath": "/orgs/{org}/copilot/billing/seats",
"access": "write",
"user-to-server": true,
"server-to-server": true,
@@ -2730,6 +2730,17 @@
"server-to-server": true,
"additional-permissions": []
},
+ {
+ "category": "repos",
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": []
+ },
{
"category": "repos",
"slug": "enable-automated-security-fixes",
diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
index e4783311cb..c32622a6bb 100644
--- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
@@ -1538,13 +1538,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing"
+ "requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats"
+ "requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -3406,6 +3406,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
+ {
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
+ },
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",
diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
index ff1abcb66b..0f1efc67ff 100644
--- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
@@ -1772,13 +1772,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing"
+ "requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats"
+ "requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -3836,6 +3836,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
+ {
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
+ },
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
index ddd64d71e7..650e8b0513 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
@@ -660,7 +660,7 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing",
+ "requestPath": "/orgs/{org}/copilot/billing",
"additional-permissions": [],
"access": "write"
},
@@ -669,7 +669,7 @@
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats",
+ "requestPath": "/orgs/{org}/copilot/billing/seats",
"additional-permissions": [],
"access": "write"
},
@@ -2741,6 +2741,15 @@
"additional-permissions": [],
"access": "write"
},
+ {
+ "category": "repos",
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
+ "additional-permissions": [],
+ "access": "write"
+ },
{
"category": "repos",
"slug": "enable-automated-security-fixes",
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
index 3268ee52b8..199c7efbb1 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
@@ -1870,13 +1870,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing"
+ "requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats"
+ "requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -4020,6 +4020,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
+ {
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
+ },
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
index 875cb46aea..cbcc649795 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
@@ -809,7 +809,7 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing",
+ "requestPath": "/orgs/{org}/copilot/billing",
"access": "write",
"user-to-server": true,
"server-to-server": true,
@@ -820,7 +820,7 @@
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats",
+ "requestPath": "/orgs/{org}/copilot/billing/seats",
"access": "write",
"user-to-server": true,
"server-to-server": true,
@@ -3420,6 +3420,17 @@
"server-to-server": true,
"additional-permissions": []
},
+ {
+ "category": "repos",
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": []
+ },
{
"category": "repos",
"slug": "enable-automated-security-fixes",
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
index c4b3fcfb45..db7732cbcc 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
@@ -1654,13 +1654,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing"
+ "requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats"
+ "requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -3656,6 +3656,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
+ {
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
+ },
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",
diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
index 3a2e5b44b3..d3de62f4c0 100644
--- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
@@ -1888,13 +1888,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing"
+ "requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats"
+ "requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -4086,6 +4086,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
+ {
+ "slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
+ "subcategory": "repos",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
+ },
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",
diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json
index 4af9a98a24..a8bc76f3aa 100644
--- a/src/github-apps/lib/config.json
+++ b/src/github-apps/lib/config.json
@@ -60,5 +60,5 @@
"2022-11-28"
]
},
- "sha": "19833171fa53a9a674f247f795f0cf44a65a05e4"
+ "sha": "741cbd72628a3a80f15ba2321e18a2237b69b803"
}
\ No newline at end of file
diff --git a/src/observability/tests/repository-references.js b/src/observability/tests/repository-references.js
index 13b35bfe83..fff2359175 100644
--- a/src/observability/tests/repository-references.js
+++ b/src/observability/tests/repository-references.js
@@ -47,6 +47,7 @@ const PUBLIC_REPOS = new Set([
'help-docs-archived-enterprise-versions',
'hubot',
'insights-releases',
+ 'issue-metrics',
'janky',
'linguist',
'localization-support',
diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json
index 94ecf63f82..41b8a69195 100644
--- a/src/rest/data/fpt-2022-11-28/schema.json
+++ b/src/rest/data/fpt-2022-11-28/schema.json
@@ -213729,7 +213729,7 @@
{
"serverUrl": "https://api.github.com",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing",
+ "requestPath": "/orgs/{org}/copilot/billing",
"title": "Get Copilot for Business seat information and settings for an organization",
"category": "copilot",
"subcategory": "copilot-for-business",
@@ -213866,7 +213866,7 @@
{
"serverUrl": "https://api.github.com",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats",
+ "requestPath": "/orgs/{org}/copilot/billing/seats",
"title": "List all Copilot for Business seat assignments for an organization",
"category": "copilot",
"subcategory": "copilot-for-business",
@@ -458725,6 +458725,95 @@
}
]
},
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
+ "title": "Check if automated security fixes are enabled for a repository",
+ "category": "repos",
+ "subcategory": "repos",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.
",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository without the .git extension. The name is not case sensitive.
",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "enabledForGitHubApps": true,
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "owner": "OWNER",
+ "repo": "REPO"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "Response if dependabot is enabled
",
+ "example": {
+ "enabled": true,
+ "paused": false
+ },
+ "schema": {
+ "title": "Check Automated Security Fixes",
+ "description": "Check Automated Security Fixes",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether automated security fixes are enabled for the repository.",
+ "examples": [
+ true
+ ]
+ },
+ "paused": {
+ "type": "boolean",
+ "description": "Whether automated security fixes are paused for the repository.",
+ "examples": [
+ false
+ ]
+ }
+ },
+ "required": [
+ "enabled",
+ "paused"
+ ]
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"Configuring automated security fixes\".
",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "Response if dependabot is enabled
"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "Not Found if dependabot is not enabled for the repository
"
+ }
+ ]
+ },
{
"serverUrl": "https://api.github.com",
"verb": "put",
diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json
index c8a28d8ab9..a4bc171c30 100644
--- a/src/rest/data/ghec-2022-11-28/schema.json
+++ b/src/rest/data/ghec-2022-11-28/schema.json
@@ -225428,7 +225428,7 @@
{
"serverUrl": "https://api.github.com",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing",
+ "requestPath": "/orgs/{org}/copilot/billing",
"title": "Get Copilot for Business seat information and settings for an organization",
"category": "copilot",
"subcategory": "copilot-for-business",
@@ -225565,7 +225565,7 @@
{
"serverUrl": "https://api.github.com",
"verb": "get",
- "requestPath": "/organizations/{org}/copilot/billing/seats",
+ "requestPath": "/orgs/{org}/copilot/billing/seats",
"title": "List all Copilot for Business seat assignments for an organization",
"category": "copilot",
"subcategory": "copilot-for-business",
@@ -475772,6 +475772,95 @@
}
]
},
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
+ "title": "Check if automated security fixes are enabled for a repository",
+ "category": "repos",
+ "subcategory": "repos",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.
",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository without the .git extension. The name is not case sensitive.
",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "enabledForGitHubApps": true,
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "owner": "OWNER",
+ "repo": "REPO"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "Response if dependabot is enabled
",
+ "example": {
+ "enabled": true,
+ "paused": false
+ },
+ "schema": {
+ "title": "Check Automated Security Fixes",
+ "description": "Check Automated Security Fixes",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether automated security fixes are enabled for the repository.",
+ "examples": [
+ true
+ ]
+ },
+ "paused": {
+ "type": "boolean",
+ "description": "Whether automated security fixes are paused for the repository.",
+ "examples": [
+ false
+ ]
+ }
+ },
+ "required": [
+ "enabled",
+ "paused"
+ ]
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"Configuring automated security fixes\".
",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "Response if dependabot is enabled
"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "Not Found if dependabot is not enabled for the repository
"
+ }
+ ]
+ },
{
"serverUrl": "https://api.github.com",
"verb": "put",
diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json
index ce5905a17e..21499549dd 100644
--- a/src/rest/data/ghes-3.6/schema.json
+++ b/src/rest/data/ghes-3.6/schema.json
@@ -306018,7 +306018,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
",
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json
index 2a7372219a..97c744059c 100644
--- a/src/rest/data/ghes-3.7/schema.json
+++ b/src/rest/data/ghes-3.7/schema.json
@@ -308989,7 +308989,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
",
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json
index 96c2fa2e97..92be4900c3 100644
--- a/src/rest/data/ghes-3.8/schema.json
+++ b/src/rest/data/ghes-3.8/schema.json
@@ -319026,7 +319026,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
",
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json
index 31cfdb82cc..0b07c34542 100644
--- a/src/rest/data/ghes-3.9-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json
@@ -321810,7 +321810,7 @@
}
],
"previews": [],
- "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
",
+ "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json
index 21165b3911..a5ef5f2abc 100644
--- a/src/rest/lib/config.json
+++ b/src/rest/lib/config.json
@@ -36,5 +36,5 @@
]
}
},
- "sha": "19833171fa53a9a674f247f795f0cf44a65a05e4"
+ "sha": "741cbd72628a3a80f15ba2321e18a2237b69b803"
}
\ No newline at end of file
diff --git a/src/rest/scripts/README.md b/src/rest/scripts/README.md
index 377cb092b6..bed3aa0c84 100644
--- a/src/rest/scripts/README.md
+++ b/src/rest/scripts/README.md
@@ -8,6 +8,16 @@ These scripts update the dereferenced OpenAPI files to create [the decorated fil
render REST docs. See the [`src/rest/README`](../../src/rest/README.md)
for more info.
+Writers and developers depend on this script to preview OpenAPI changes in the docs. When you update this script please [follow the preview steps here](https://thehub.github.com/epd/engineering/products-and-services/public-apis/rest/openapi/openapi-in-the-docs/#previewing-changes-in-the-docs) to verify that:
+
+- The script runs without errors
+- You can preview REST API changes
+- You can preview webhook changes
+- You can generate a preview for an individual version (e.g. GHEC only)
+- You can generate a preview when a new category is added
+- You can generate a preview when a new subcategory is added
+- You can generate a preview when a new category and subcategory are added together
+
## Production `--decorate-only` option
When changes to the OpenAPI are merged to the default branch of the `github/github` repository, a pull request is automatically opened with the updated dereferenced OpenAPI files. When pull requests are authored by `github-openapi-bot`, a CI test runs the `src/rest/scripts/update-files.js` script with the `--decorate-only` option. The `--decorate-only` option only decorates the dereferenced OpenAPI files, using the existing dereferenced OpenAPI schema files, and checks those changes in to the existing branch. The `--decorate-only` option is only used by a 🤖 and is only used on production dereferenced OpenAPI schema files.
diff --git a/src/search/scripts/build-records.js b/src/search/scripts/build-records.js
index 778aa87657..dec42edfb5 100644
--- a/src/search/scripts/build-records.js
+++ b/src/search/scripts/build-records.js
@@ -24,6 +24,12 @@ dotenv.config()
const MAX_CONCURRENT = parseInt(process.env.BUILD_RECORDS_MAX_CONCURRENT || '200', 10)
const MIN_TIME = parseInt(process.env.BUILD_RECORDS_MIN_TIME || '5', 10)
+// These products, forcibly always get a popularity of 0 independent of
+// their actual popularity which comes from an external JSON file.
+// The objective for this is to reduce their search result ranking
+// when multiple docs match on a certain keyword(s).
+const FORCE_0_POPULARITY_PRODUCTS = new Set(['contributing'])
+
export default async function buildRecords(
indexName,
indexablePages,
@@ -71,8 +77,15 @@ export default async function buildRecords(
if (!noMarkers) process.stdout.write(pageMarker)
const newRecord = parsePageSectionsIntoRecords(page)
const pathArticle = page.relativePath.replace('/index.md', '').replace('.md', '')
- const popularity = (hasPopularPages && popularPages[pathArticle]) || 0.0
+ let popularity = (hasPopularPages && popularPages[pathArticle]) || 0.0
+ if (FORCE_0_POPULARITY_PRODUCTS.size) {
+ const product = newRecord.objectID.split('/')[2]
+ if (FORCE_0_POPULARITY_PRODUCTS.has(product)) {
+ popularity = 0.0
+ }
+ }
newRecord.popularity = popularity
+
if (!noMarkers) process.stdout.write(recordMarker)
records.push(newRecord)
})
diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json
index afc486647d..59b1fb5372 100644
--- a/src/webhooks/lib/config.json
+++ b/src/webhooks/lib/config.json
@@ -1,3 +1,3 @@
{
- "sha": "19833171fa53a9a674f247f795f0cf44a65a05e4"
+ "sha": "741cbd72628a3a80f15ba2321e18a2237b69b803"
}
\ No newline at end of file