Skip to content

Commit dc9d332

Browse files
authored
Merge pull request #81 from github/repo-sync
repo sync
2 parents 439e7e0 + 733b0ba commit dc9d332

File tree

8 files changed

+25
-20
lines changed

8 files changed

+25
-20
lines changed

content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ If you don't define a configuration in your repository, {% data variables.produc
2121

2222
You can create a default codespace configuration using a pre-built container configuration for your project type, or you can create a custom configuration specific to your project's needs.
2323

24-
{% data variables.product.prodname_codespaces %} uses settings contained in a file named `devcontainer.json` in the root of the repository or in a `.devcontainer` folder. You can use `devcontainer.json` to set default settings for the entire codespace environment, including the {% data variables.product.prodname_vscode %} editor, but you can also set editor-specific settings in a file named `.vscode/settings.json`.
24+
{% data variables.product.prodname_codespaces %} uses settings contained in a configuration file named `devcontainer.json`. {% data reusables.codespaces.devcontainer-location %}
25+
26+
You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the {% data variables.product.prodname_vscode %} editor, but you can also set editor-specific settings in a file named `.vscode/settings.json`.
2527

2628
Changes to a repository's codespace configuration apply only to every new codespace and do not affect any existing codespace.
2729

@@ -38,7 +40,9 @@ Each new codespace created from a branch which contains the `.devcontainer` fold
3840

3941
### Creating a custom codespace configuration
4042

41-
If none of the pre-built configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file to the root of your repository or a `.devcontainer` folder. In the file, you can use supported configuration keys to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed.
43+
If none of the pre-built configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file. {% data reusables.codespaces.devcontainer-location %}
44+
45+
In the file, you can use supported configuration keys to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed.
4246

4347
{% data reusables.codespaces.vscode-settings-order %}
4448

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This file can be located in the root of the repository or in a folder called `.devcontainer`. If the file is located in the root of the repository, the filename must begin with a period: `.devcontainer.json`.

lib/enterprise-server-releases.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const versionSatisifiesRange = require('./version-satisfies-range')
1+
const versionSatisfiesRange = require('./version-satisfies-range')
22

33
// GHES Release Lifecycle Dates:
44
// https://github.com/github/enterprise-releases/blob/master/docs/supported-versions.md#release-lifecycle-dates
@@ -36,7 +36,7 @@ const all = supported.concat(deprecated)
3636
const latest = supported[0]
3737
const oldestSupported = supported[supported.length - 1]
3838
const nextDeprecationDate = dates[oldestSupported].deprecationDate
39-
const deprecatedOnNewSite = deprecated.filter(version => versionSatisifiesRange(version, '>=2.13'))
39+
const deprecatedOnNewSite = deprecated.filter(version => versionSatisfiesRange(version, '>=2.13'))
4040
const firstVersionDeprecatedOnNewSite = '2.13'
4141
// starting from 2.18, we updated the archival script to create stubbed HTML redirect files
4242
const lastVersionWithoutStubbedRedirectFiles = '2.17'

lib/get-applicable-versions.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const allVersions = require('./all-versions')
2-
const versionSatisifiesRange = require('./version-satisfies-range')
2+
const versionSatisfiesRange = require('./version-satisfies-range')
33

44
// return an array of versions that an article's product versions encompasses
55
function getApplicableVersions (frontmatterVersions, filepath) {
@@ -33,7 +33,7 @@ function getApplicableVersions (frontmatterVersions, filepath) {
3333
relevantVersions.forEach(relevantVersion => {
3434
// special handling for versions with numbered releases
3535
if (relevantVersion.hasNumberedReleases) {
36-
if (versionSatisifiesRange(relevantVersion.currentRelease, planValue)) {
36+
if (versionSatisfiesRange(relevantVersion.currentRelease, planValue)) {
3737
applicableVersions.push(relevantVersion.version)
3838
}
3939
} else {

lib/redirects/get-old-paths-from-permalink.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
const { latest, lastReleaseWithLegacyFormat } = require('../enterprise-server-releases')
22
const { getPathWithoutLanguage, getPathWithLanguage } = require('../path-utils')
33
const patterns = require('../patterns')
4-
const versionSatisifiesRange = require('../version-satisfies-range')
4+
const versionSatisfiesRange = require('../version-satisfies-range')
55
const currentlySupportedVersions = Object.keys(require('../all-versions'))
66
const nonEnterpriseDefaultVersion = require('../non-enterprise-default-version')
77

@@ -32,7 +32,7 @@ module.exports = function getOldPathsFromPath (currentPath, languageCode, curren
3232
}
3333

3434
// create old path /user from current path /user/github on 2.16+ only
35-
if (currentlySupportedVersions.includes(currentVersion) || versionSatisifiesRange(currentVersion, '>2.15')) {
35+
if (currentlySupportedVersions.includes(currentVersion) || versionSatisfiesRange(currentVersion, '>2.15')) {
3636
oldPaths.add(currentPath
3737
.replace('/user/github', '/user'))
3838
}
@@ -55,7 +55,7 @@ module.exports = function getOldPathsFromPath (currentPath, languageCode, curren
5555
// ------ END LEGACY VERSION FORMAT REPLACEMENTS ------//
5656

5757
// ------ BEGIN MODERN VERSION FORMAT REPLACEMENTS ------//
58-
if (currentlySupportedVersions.includes(currentVersion) || versionSatisifiesRange(currentVersion, `>${lastReleaseWithLegacyFormat}`)) {
58+
if (currentlySupportedVersions.includes(currentVersion) || versionSatisfiesRange(currentVersion, `>${lastReleaseWithLegacyFormat}`)) {
5959
oldPaths.forEach(oldPath => {
6060
// create old path /github from new path /free-pro-team@latest/github
6161
oldPaths.add(oldPath

lib/version-satisfies-range.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ const semver = require('semver')
22

33
// workaround for Enterprise Server 11.10.340 because we can't use semver to
44
// compare it to 2.x like we can with 2.0+
5-
module.exports = function versionSatisifiesRange (version, range) {
5+
module.exports = function versionSatisfiesRange (version, range) {
66
if (version === '11.10.340') return range.startsWith('<')
77

88
return semver.satisfies(semver.coerce(version), range)

middleware/archived-enterprise-versions-assets.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const path = require('path')
2-
const versionSatisifiesRange = require('../lib/version-satisfies-range')
2+
const versionSatisfiesRange = require('../lib/version-satisfies-range')
33
const enterpriseServerReleases = require('../lib/enterprise-server-releases')
44
const patterns = require('../lib/patterns')
55
const firstVersionDeprecatedOnNewSite = '2.13'
@@ -32,10 +32,10 @@ module.exports = async (req, res, next) => {
3232

3333
// paths are slightly different depending on the enterprise version
3434
let proxyPath
35-
if (versionSatisifiesRange(requestedVersion, `>=${firstVersionDeprecatedOnNewSite}`)) {
35+
if (versionSatisfiesRange(requestedVersion, `>=${firstVersionDeprecatedOnNewSite}`)) {
3636
// routing for >=2.13
3737
proxyPath = path.join('/', requestedVersion, assetPath)
38-
} else if (versionSatisifiesRange(requestedVersion, `<${firstVersionDeprecatedOnNewSite}`)) {
38+
} else if (versionSatisfiesRange(requestedVersion, `<${firstVersionDeprecatedOnNewSite}`)) {
3939
// routing for <2.13
4040
proxyPath = path.join('/', requestedVersion, 'assets', assetPath)
4141
}

middleware/archived-enterprise-versions.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
const path = require('path')
22
const { latest, deprecated, firstVersionDeprecatedOnNewSite, lastVersionWithoutStubbedRedirectFiles } = require('../lib/enterprise-server-releases')
33
const patterns = require('../lib/patterns')
4-
const versionSatisifiesRange = require('../lib/version-satisfies-range')
4+
const versionSatisfiesRange = require('../lib/version-satisfies-range')
55
const got = require('got')
66
const findPage = require('../lib/find-page')
77

@@ -26,14 +26,14 @@ module.exports = async (req, res, next) => {
2626

2727
// redirect language-prefixed URLs like /en/enterprise/2.10 -> /enterprise/2.10
2828
// (this only applies to versions <2.13)
29-
if (req.path.startsWith('/en/') && versionSatisifiesRange(requestedVersion, `<${firstVersionDeprecatedOnNewSite}`)) {
29+
if (req.path.startsWith('/en/') && versionSatisfiesRange(requestedVersion, `<${firstVersionDeprecatedOnNewSite}`)) {
3030
return res.redirect(301, req.baseUrl + req.path.replace(/^\/en/, ''))
3131
}
3232

3333
// find redirects for versions between 2.13 and 2.17
3434
// starting with 2.18, we updated the archival script to create stubbed HTML redirect files
35-
if (versionSatisifiesRange(requestedVersion, `>=${firstVersionDeprecatedOnNewSite}`) &&
36-
versionSatisifiesRange(requestedVersion, `<=${lastVersionWithoutStubbedRedirectFiles}`)) {
35+
if (versionSatisfiesRange(requestedVersion, `>=${firstVersionDeprecatedOnNewSite}`) &&
36+
versionSatisfiesRange(requestedVersion, `<=${lastVersionWithoutStubbedRedirectFiles}`)) {
3737
const redirect = req.context.redirects[req.path]
3838
if (redirect && redirect !== req.path) {
3939
return res.redirect(301, redirect)
@@ -68,7 +68,7 @@ module.exports = async (req, res, next) => {
6868
// for >=2.13: /2.13/en/enterprise/2.13/user/articles/viewing-contributions-on-your-profile
6969
// for <2.13: /2.12/user/articles/viewing-contributions-on-your-profile
7070
function getProxyPath (reqPath, requestedVersion) {
71-
const proxyPath = versionSatisifiesRange(requestedVersion, `>=${firstVersionDeprecatedOnNewSite}`)
71+
const proxyPath = versionSatisfiesRange(requestedVersion, `>=${firstVersionDeprecatedOnNewSite}`)
7272
? path.join('/', requestedVersion, reqPath)
7373
: reqPath.replace(/^\/enterprise/, '')
7474

@@ -78,8 +78,8 @@ function getProxyPath (reqPath, requestedVersion) {
7878
// from 2.13 to 2.17, we lost access to frontmatter redirects during the archival process
7979
// this workaround finds potentially relevant frontmatter redirects in currently supported pages
8080
function getFallbackRedirects (req, requestedVersion) {
81-
if (versionSatisifiesRange(requestedVersion, `<${firstVersionDeprecatedOnNewSite}`)) return
82-
if (versionSatisifiesRange(requestedVersion, `>${lastVersionWithoutStubbedRedirectFiles}`)) return
81+
if (versionSatisfiesRange(requestedVersion, `<${firstVersionDeprecatedOnNewSite}`)) return
82+
if (versionSatisfiesRange(requestedVersion, `>${lastVersionWithoutStubbedRedirectFiles}`)) return
8383

8484
const pathWithNewVersion = req.path.replace(requestedVersion, latest)
8585

0 commit comments

Comments
 (0)