1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Include audit logs data in Enterprise deprecations (#58576)

This commit is contained in:
Kevin Heis
2025-12-01 12:58:21 -08:00
committed by GitHub
parent 4e06d7efdf
commit 1c41d47e97
20 changed files with 36 additions and 256337 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,9 +1,11 @@
{ {
"automation-pipelines": [ "automation-pipelines": [
"audit-logs",
"codeql-cli", "codeql-cli",
"github-apps", "github-apps",
"graphql", "graphql",
"rest", "rest",
"secret-scanning",
"webhooks" "webhooks"
] ]
} }

View File

@@ -64,49 +64,49 @@ All previously archived content lives in its own repository. For example, GHES 3
1. Hide search components temporarily while scraping docs by adding the `visually-hidden` class to the search components: 1. Hide search components temporarily while scraping docs by adding the `visually-hidden` class to the search components:
**In `src/search/components/input/SearchBarButton.tsx`**, wrap the return statement content: **In `src/search/components/input/SearchBarButton.tsx`**, wrap the return statement content:
```javascript ```javascript
return ( return (
<div className="visually-hidden"> <div className="visually-hidden">
{/* existing search button content */} {/* existing search button content */}
</div> </div>
) );
``` ```
**In `src/search/components/input/SearchOverlayContainer.tsx`**, wrap the return statement content: **In `src/search/components/input/SearchOverlayContainer.tsx`**, wrap the return statement content:
```javascript ```javascript
if (isSearchOpen) { if (isSearchOpen) {
return ( return (
<div className="visually-hidden"> <div className="visually-hidden">
<SearchOverlay <SearchOverlay
// ... existing props // ... existing props
/> />
</div> </div>
) );
} }
``` ```
1. Ensure your build is up to date: 1. Ensure your build is up to date:
```shell ```shell
npm run build npm run build
``` ```
1. Do a dry run by scraping a small amount of files to test locally on your machine. This command does not overwrite the references to asset files so they will render on your machine. 1. Do a dry run by scraping a small amount of files to test locally on your machine. This command does not overwrite the references to asset files so they will render on your machine.
```shell ```shell
npm run deprecate-ghes-archive -- --dry-run --local-dev npm run deprecate-ghes-archive -- --dry-run --local-dev
``` ```
1. Navigate to the scraped files directory (`tmpArchivalDir_<VERSION_TO_DEPRECATE>`) inside your docs-internal checkout. Open a few HTML files and ensure they render and drop-down pickers work correctly. 1. Navigate to the scraped files directory (`tmpArchivalDir_<VERSION_TO_DEPRECATE>`) inside your docs-internal checkout. Open a few HTML files and ensure they render and drop-down pickers work correctly.
1. If the dry-run looks good, scrape all content files. This will take about 20-30 minutes. **Note:** This will overwrite the directory that was previously generated with new files. You can also create a specific output directory using the `--output` flag. 1. If the dry-run looks good, scrape all content files. This will take about 20-30 minutes. **Note:** This will overwrite the directory that was previously generated with new files. You can also create a specific output directory using the `--output` flag.
```shell ```shell
npm run deprecate-ghes-archive npm run deprecate-ghes-archive
``` ```
1. Revert changes to `src/search/components/input/SearchBarButton.tsx` and `src/search/components/input/SearchOverlayContainer.tsx`. 1. Revert changes to `src/search/components/input/SearchBarButton.tsx` and `src/search/components/input/SearchOverlayContainer.tsx`.
@@ -128,7 +128,7 @@ All previously archived content lives in its own repository. For example, GHES 3
1. In your `docs-internal` checkout, edit `src/versions/lib/enterprise-server-releases.ts` by removing the version number to be deprecated from the `supported` array and move it to the `deprecatedWithFunctionalRedirects` array. 1. In your `docs-internal` checkout, edit `src/versions/lib/enterprise-server-releases.ts` by removing the version number to be deprecated from the `supported` array and move it to the `deprecatedWithFunctionalRedirects` array.
1. Deprecate the automated pipelines data files: 1. Deprecate the automated pipelines data files (including audit logs, REST, GraphQL, webhooks, GitHub Apps, CodeQL CLI, and secret scanning):
```shell ```shell
npm run deprecate-ghes -- pipelines npm run deprecate-ghes -- pipelines
@@ -136,9 +136,9 @@ All previously archived content lives in its own repository. For example, GHES 3
1. Remove deprecated content files and update the versions frontmatter: 1. Remove deprecated content files and update the versions frontmatter:
```shell ```shell
npm run deprecate-ghes -- content npm run deprecate-ghes -- content
``` ```
1. Remove deprecated Liquid from content and data files. **Note:** The previous step to update content file frontmatter must have run successfully for this step to work because the updated frontmatter is used to determine file versions. 1. Remove deprecated Liquid from content and data files. **Note:** The previous step to update content file frontmatter must have run successfully for this step to work because the updated frontmatter is used to determine file versions.
@@ -171,6 +171,7 @@ All previously archived content lives in its own repository. For example, GHES 3
``` ```
1. Poke around several deprecated pages by navigating to `docs.github.com/enterprise/<DEPRECATED VERSION>`, and ensure that: 1. Poke around several deprecated pages by navigating to `docs.github.com/enterprise/<DEPRECATED VERSION>`, and ensure that:
- Stylesheets are working properly - Stylesheets are working properly
- Images are rendering properly - Images are rendering properly
- The search functionality was disabled during scraping - The search functionality was disabled during scraping