Skip to content

Commit 0421bb1

Browse files
authored
Branch was updated using the 'autoupdate branch' Actions workflow.
2 parents 2d611a4 + f01bde3 commit 0421bb1

14 files changed

+53
-654
lines changed

script/README.md

Lines changed: 42 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,6 @@ Usage: script/anonymize-branch.js <new-commit-message> [base-branch] Example: sc
3939
---
4040

4141

42-
### [`archive-enterprise-version.js`](archive-enterprise-version.js)
43-
44-
Run this script during the Enterprise deprecation process to download static copies of all pages for the oldest supported Enterprise version. See the Enterprise deprecation issue template for instructions.
45-
46-
---
47-
48-
4942
### [`backfill-missing-localizations.js`](backfill-missing-localizations.js)
5043

5144
This script copies any English files that are missing from the translations directory into the translations directory. We only need to run this if problems occur with Crowdin's automatic sync.
@@ -64,11 +57,9 @@ The `ignore` array is for client-side or build-time stuff that doesn't get `requ
6457
---
6558

6659

67-
### [`check-external-links`](check-external-links)
68-
69-
The script is run once per day via a scheduled GitHub Action to check all links in the site. It automatically opens an issue if it finds broken links. To exclude a URL from the link check, add it to `lib/excluded-links.js`.
60+
### [`check-english-links.js`](check-english-links.js)
7061

71-
For checking internal links, see `script/check-internal-links`.
62+
This script runs once per day via a scheduled GitHub Action to check all links in English content, not including deprecated Enterprise Server content. It opens an issue if it finds broken links. To exclude a link, add it to `lib/excluded-links.js`.
7263

7364
---
7465

@@ -80,37 +71,35 @@ This script is run automatically when you run the server locally. It checks whet
8071
---
8172

8273

83-
### [`check-internal-links`](check-internal-links)
84-
85-
This script wraps tests/links-and-images.js and provides an option to output results to a file.
74+
### [`check-s3-images.js`](check-s3-images.js)
8675

87-
For more information, see `tests/README.md#broken-link-test`.
76+
Run this script in your branch to check whether any images referenced in content are not in an expected S3 bucket. You will need to authenticate to S3 via `awssume` to use this script. Instructions for the one-time setup are [here](https://github.com/github/product-documentation/blob/master/doc-team-workflows/workflow-information-for-all-writers/setting-up-awssume-and-s3cmd.md).
8877

8978
---
9079

9180

92-
### [`check-s3-images.js`](check-s3-images.js)
81+
### [`content-migrations/extended-markdown-tags.js`](content-migrations/extended-markdown-tags.js)
82+
9383

94-
Run this script in your branch to check whether any images referenced in Enterprise content are not in the expected S3 bucket. You will need to authenticate to S3 via `awssume` to use this script. Instructions for the one-time setup are [here](https://github.com/github/product-documentation/blob/master/doc-team-workflows/workflow-information-for-all-writers/setting-up-awssume-and-s3cmd.md).
9584

9685
---
9786

9887

99-
### [`content-migrations/extended-markdown-tags.js`](content-migrations/extended-markdown-tags.js)
88+
### [`content-migrations/octicon-tag.js`](content-migrations/octicon-tag.js)
10089

10190

10291

10392
---
10493

10594

106-
### [`content-migrations/octicon-tag.js`](content-migrations/octicon-tag.js)
95+
### [`content-migrations/site-data-tag.js`](content-migrations/site-data-tag.js)
10796

10897

10998

11099
---
111100

112101

113-
### [`content-migrations/site-data-tag.js`](content-migrations/site-data-tag.js)
102+
### [`content-migrations/update-developer-site-links.js`](content-migrations/update-developer-site-links.js)
114103

115104

116105

@@ -131,9 +120,37 @@ This script finds and lists all the Heroku staging apps and deletes any leftover
131120
---
132121

133122

134-
### [`get-blc-command.js`](get-blc-command.js)
123+
### [`enterprise-server-deprecations/archive-version.js`](enterprise-server-deprecations/archive-version.js)
124+
125+
Run this script during the Enterprise deprecation process to download static copies of all pages for the oldest supported Enterprise version. See the Enterprise deprecation issue template for instructions.
126+
127+
---
128+
129+
130+
### [`enterprise-server-deprecations/remove-version-markup.js`](enterprise-server-deprecations/remove-version-markup.js)
135131

136-
This script parses options for `script/check-external-links`.
132+
Run this script after an Enterprise deprecation to remove Liquid statements and frontmatter that contain the deprecated Enterprise version. See the Enterprise deprecation issue template for instructions.
133+
134+
---
135+
136+
137+
### [`enterprise-server-releases/create-webhooks-for-new-version.js`](enterprise-server-releases/create-webhooks-for-new-version.js)
138+
139+
This script creates new static webhook payload files for a new version.
140+
141+
---
142+
143+
144+
### [`enterprise-server-releases/ghes-to-ghae-versioning.js`](enterprise-server-releases/ghes-to-ghae-versioning.js)
145+
146+
Run this script to add versions frontmatter and Liquid conditionals for GitHub AE, based on anything currently versioned for the provided release of Enterprise Server. This script should be run as part of the Enterprise Server release process.
147+
148+
---
149+
150+
151+
### [`enterprise-server-releases/release-banner.js`](enterprise-server-releases/release-banner.js)
152+
153+
This script creates or removes a release candidate banner for a specified version.
137154

138155
---
139156

@@ -242,63 +259,6 @@ This script moves reusables out of YAML files into individual Markdown files.
242259
---
243260

244261

245-
### [`new-versioning/fixtures.js`](new-versioning/fixtures.js)
246-
247-
248-
249-
---
250-
251-
252-
### [`new-versioning/main`](new-versioning/main)
253-
254-
All the new versioning!
255-
256-
Usage $ script/new-versioning/main
257-
258-
---
259-
260-
261-
### [`new-versioning/move-admin-dir.js`](new-versioning/move-admin-dir.js)
262-
263-
264-
265-
---
266-
267-
268-
### [`new-versioning/update-content.js`](new-versioning/update-content.js)
269-
270-
271-
272-
---
273-
274-
275-
### [`new-versioning/update-frontmatter.js`](new-versioning/update-frontmatter.js)
276-
277-
278-
279-
---
280-
281-
282-
### [`new-versioning/update-not-fpt-conditionals.js`](new-versioning/update-not-fpt-conditionals.js)
283-
284-
Run this script to update these Liquid conditionals:
285-
286-
{% if currentVersion != 'free-pro-team@latest' %}
287-
288-
to:
289-
290-
{% if enterpriseServerVersions contains currentVersion %}
291-
292-
---
293-
294-
295-
### [`new-versioning/update-products-yml.js`](new-versioning/update-products-yml.js)
296-
297-
298-
299-
---
300-
301-
302262
### [`pages-with-liquid-titles.js`](pages-with-liquid-titles.js)
303263

304264
This is a temporary script to visualize which pages have liquid (and conditionals) in their `title` frontmatter
@@ -368,20 +328,6 @@ An automated test checks for discrepancies between filenames and [autogenerated
368328
---
369329

370330

371-
### [`release-banner.js`](release-banner.js)
372-
373-
This script creates or removes a release candidate banner for a specified version.
374-
375-
376-
---
377-
378-
### [`remove-deprecated-enterprise-version-markup.js`](remove-deprecated-enterprise-version-markup.js)
379-
380-
Run this script after an Enterprise deprecation to remove Liquid statements and frontmatter that contain the deprecated Enterprise version. See the Enterprise deprecation issue template for instructions.
381-
382-
---
383-
384-
385331
### [`remove-extraneous-translation-files.js`](remove-extraneous-translation-files.js)
386332

387333
An [automated test](/tests/extraneous-translation-files.js) checks for files in the `translations/` directory that do not have an equivalent English file in the `content/` directory, and fails if it finds extraneous files. When the test fails, a human needs to run this script to remove the files.
@@ -488,9 +434,10 @@ This script is used by other scripts to update temporary AWS credentials and aut
488434
---
489435

490436

491-
### [`upload-enterprise-images-to-s3.js`](upload-enterprise-images-to-s3.js)
437+
### [`upload-images-to-s3.js`](upload-images-to-s3.js)
492438

493-
Run this script to: [upload individual files to S3](https://github.com/github/product-documentation/blob/master/doc-team-workflows/workflow-information-for-all-writers/adding-individual-images-to-earlier-verisons-of-enterprise.md) or: [upload a batch of files to S3 for a new Enterprise release](https://github.com/github/product-documentation/blob/master/doc-team-workflows/working-on-enterprise-releases/information-for-all-writers/storing-a-batch-of-assets-on-s3-for-a-new-release.md). Run `upload-enterprise-images-to-s3.js --help` for usage details.
439+
Use this script to upload individual or batched asset files to a versioned S3 bucket. Run `upload-images-to-s3.js --help` for usage details.
494440

495441
---
496442

443+

script/archive-enterprise-version.js renamed to script/enterprise-server-deprecations/archive-version.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ const scrape = require('website-scraper')
1010
const program = require('commander')
1111
const rimraf = require('rimraf').sync
1212
const mkdirp = require('mkdirp').sync
13-
const version = require('../lib/enterprise-server-releases').oldestSupported
13+
const version = require('../../lib/enterprise-server-releases').oldestSupported
1414
const archivalRepoName = 'help-docs-archived-enterprise-versions'
1515
const archivalRepoUrl = `https://github.com/github/${archivalRepoName}`
16-
const loadRedirects = require('../lib/redirects/precompile')
16+
const loadRedirects = require('../../lib/redirects/precompile')
1717

1818
// [start-readme]
1919
//
@@ -95,7 +95,7 @@ async function main () {
9595
}
9696

9797
console.log(`Enterprise version to archive: ${version}`)
98-
const pages = await (require('../lib/pages')())
98+
const pages = await (require('../../lib/pages')())
9999
const permalinksPerVersion = Object.keys(pages)
100100
.filter(key => key.includes(`/enterprise-server@${version}`))
101101

script/remove-deprecated-enterprise-version-markup.js renamed to script/enterprise-server-deprecations/remove-version-markup.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ const walk = require('walk-sync')
66
const matter = require('gray-matter')
77
const program = require('commander')
88
const { indexOf, nth } = require('lodash')
9-
const removeLiquidStatements = require('../lib/remove-liquid-statements')
10-
const removeDeprecatedFrontmatter = require('../lib/remove-deprecated-frontmatter')
11-
const enterpriseServerReleases = require('../lib/enterprise-server-releases')
12-
const contentPath = path.join(__dirname, '../content')
13-
const dataPath = path.join(__dirname, '../data')
9+
const removeLiquidStatements = require('../../lib/remove-liquid-statements')
10+
const removeDeprecatedFrontmatter = require('../../lib/remove-deprecated-frontmatter')
11+
const enterpriseServerReleases = require('../../lib/enterprise-server-releases')
12+
const contentPath = path.join(__dirname, '../../content')
13+
const dataPath = path.join(__dirname, '../../data')
1414
const removeUnusedAssetsScript = 'script/remove-unused-assets'
1515
const elseifRegex = /{-?% elsif/
1616

@@ -62,7 +62,7 @@ const allFiles = contentFiles.concat(dataFiles)
6262

6363
main()
6464
console.log(`\nRunning ${removeUnusedAssetsScript}...`)
65-
require(`../${removeUnusedAssetsScript}`)
65+
require(path.join(process.cwd(), removeUnusedAssetsScript))
6666

6767
function printElseIfFoundWarning (location) {
6868
console.log(`${location} has an 'elsif' condition! Resolve all elsifs by hand, then rerun the script.`)

script/create-webhooks-for-new-version.js renamed to script/enterprise-server-releases/create-webhook-files.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const fs = require('fs')
44
const mkdirp = require('mkdirp').sync
55
const path = require('path')
66
const program = require('commander')
7-
const allVersions = require('../lib/all-versions')
7+
const allVersions = require('../../lib/all-versions')
88

99
// [start-readme]
1010
//

script/release-banner.js renamed to script/enterprise-server-releases/release-banner.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const fs = require('fs')
44
const path = require('path')
55
const program = require('commander')
66
const yaml = require('js-yaml')
7-
const allVersions = require('../lib/all-versions')
7+
const allVersions = require('../../lib/all-versions')
88
const releaseCandidateFile = 'data/variables/release_candidate.yml'
99
const releaseCandidateYaml = path.join(process.cwd(), releaseCandidateFile)
1010

0 commit comments

Comments
 (0)