Skip to content

Commit 6a3d326

Browse files
authored
add one-off cases for hooks and pre-receive-hooks (#16784)
* add one-off cases for hooks and pre-receive-hooks * add forum redirect * update redirect test * update 2.19-2.22 fixutres * revert 2.18/2.19 changes * remove dotcom test * update dotcom test
1 parent 910a94b commit 6a3d326

4 files changed

Lines changed: 34 additions & 14 deletions

File tree

content/github/working-with-github-support/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Working with GitHub Support
33
redirect_from:
44
- /categories/working-with-github-support
5+
- /forum
56
versions:
67
free-pro-team: '*'
78
---

lib/redirects/get-docs-path-from-developer-path.js

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,25 @@ module.exports = function getDocsPathFromDeveloperPath (oldDeveloperPath, allRed
1515
// oneoff redirect
1616
const v3OrgPreReceiveHooks = '/v3/orgs/pre_receive_hooks'
1717
if (newPath.endsWith(v3OrgPreReceiveHooks)) {
18-
newPath = newPath.replace(v3OrgPreReceiveHooks, '/v3/enterprise-admin/org_pre_receive_hooks')
18+
newPath = newPath.replace(v3OrgPreReceiveHooks, '/v3/enterprise-admin/organization_pre_receive_hooks')
19+
}
20+
21+
// oneoff redirect
22+
const v3RepoPreReceiveHooks = '/v3/repos/pre_receive_hooks'
23+
if (newPath.endsWith(v3RepoPreReceiveHooks)) {
24+
newPath = newPath.replace(v3RepoPreReceiveHooks, '/v3/enterprise-admin/repository_pre_receive_hooks')
25+
}
26+
27+
// oneoff redirect
28+
const v3OrgHooks = '/v3/orgs/hooks'
29+
if (newPath.endsWith(v3OrgHooks)) {
30+
newPath = newPath.replace(v3OrgHooks, '/v3/orgs/webhooks')
31+
}
32+
33+
// oneoff redirect
34+
const v3RepoHooks = '/v3/repos/hooks'
35+
if (newPath.endsWith(v3RepoHooks)) {
36+
newPath = newPath.replace(v3RepoHooks, '/v3/repos/webhooks')
1937
}
2038

2139
// oneoff redirect for a dotcom developer path to Enterprise-only path on docs.github.com
@@ -46,6 +64,7 @@ module.exports = function getDocsPathFromDeveloperPath (oldDeveloperPath, allRed
4664
.replace(/_/g, '-')
4765
// this is a special oneoff replacement
4866
.replace('org-pre-receive-hooks', 'organization-pre-receive-hooks')
67+
.replace('repo-pre-receive-hooks', 'repository-pre-receive-hooks')
4968
: lastSegment
5069
}
5170

tests/fixtures/rest-redirects.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@
219219
"/en/enterprise/2.20/v3/enterprise-admin/orgs": "/en/enterprise-server@2.20/rest/reference/enterprise-admin#orgs",
220220
"/en/enterprise/2.20/v3/enterprise-admin/pre_receive_environments": "/en/enterprise-server@2.20/rest/reference/enterprise-admin#pre-receive-environments",
221221
"/en/enterprise/2.20/v3/enterprise-admin/pre_receive_hooks": "/en/enterprise-server@2.20/rest/reference/enterprise-admin#pre-receive-hooks",
222-
"/en/enterprise/2.20/v3/enterprise-admin/repo_pre_receive_hooks": "/en/enterprise-server@2.20/rest/reference/enterprise-admin#repo-pre-receive-hooks",
222+
"/en/enterprise/2.20/v3/enterprise-admin/repo_pre_receive_hooks": "/en/enterprise-server@2.20/rest/reference/enterprise-admin#repository-pre-receive-hooks",
223223
"/en/enterprise/2.20/v3/enterprise-admin/search_indexing": "/en/enterprise-server@2.20/rest/reference/enterprise-admin#search-indexing",
224224
"/en/enterprise/2.20/v3/enterprise-admin/users": "/en/enterprise-server@2.20/rest/reference/enterprise-admin#users",
225225
"/en/enterprise/2.20/v3/gists/comments": "/en/enterprise-server@2.20/rest/reference/gists#comments",
@@ -243,7 +243,7 @@
243243
"/en/enterprise/2.20/v3/markdown": "/en/enterprise-server@2.20/rest/reference/markdown",
244244
"/en/enterprise/2.20/v3/meta": "/en/enterprise-server@2.20/rest/reference/meta",
245245
"/en/enterprise/2.20/v3/oauth_authorizations": "/en/enterprise-server@2.20/rest/reference/oauth-authorizations",
246-
"/en/enterprise/2.20/v3/orgs/hooks": "/en/enterprise-server@2.20/rest/reference/orgs#hooks",
246+
"/en/enterprise/2.20/v3/orgs/hooks": "/en/enterprise-server@2.20/rest/reference/orgs#webhooks",
247247
"/en/enterprise/2.20/v3/orgs": "/en/enterprise-server@2.20/rest/reference/orgs",
248248
"/en/enterprise/2.20/v3/orgs/members": "/en/enterprise-server@2.20/rest/reference/orgs#members",
249249
"/en/enterprise/2.20/v3/orgs/outside_collaborators": "/en/enterprise-server@2.20/rest/reference/orgs#outside-collaborators",
@@ -267,13 +267,13 @@
267267
"/en/enterprise/2.20/v3/repos/deployments": "/en/enterprise-server@2.20/rest/reference/repos#deployments",
268268
"/en/enterprise/2.20/v3/repos/downloads": "/en/enterprise-server@2.20/rest/reference/repos#downloads",
269269
"/en/enterprise/2.20/v3/repos/forks": "/en/enterprise-server@2.20/rest/reference/repos#forks",
270-
"/en/enterprise/2.20/v3/repos/hooks": "/en/enterprise-server@2.20/rest/reference/repos#hooks",
270+
"/en/enterprise/2.20/v3/repos/hooks": "/en/enterprise-server@2.20/rest/reference/repos#webhooks",
271271
"/en/enterprise/2.20/v3/repos": "/en/enterprise-server@2.20/rest/reference/repos",
272272
"/en/enterprise/2.20/v3/repos/invitations": "/en/enterprise-server@2.20/rest/reference/repos#invitations",
273273
"/en/enterprise/2.20/v3/repos/keys": "/en/enterprise-server@2.20/rest/reference/repos#keys",
274274
"/en/enterprise/2.20/v3/repos/merging": "/en/enterprise-server@2.20/rest/reference/repos#merging",
275275
"/en/enterprise/2.20/v3/repos/pages": "/en/enterprise-server@2.20/rest/reference/repos#pages",
276-
"/en/enterprise/2.20/v3/repos/pre_receive_hooks": "/en/enterprise-server@2.20/rest/reference/repos#pre-receive-hooks",
276+
"/en/enterprise/2.20/v3/repos/pre_receive_hooks": "/en/enterprise-server@2.20/rest/reference/enterprise-admin#repository-pre-receive-hooks",
277277
"/en/enterprise/2.20/v3/repos/releases": "/en/enterprise-server@2.20/rest/reference/repos#releases",
278278
"/en/enterprise/2.20/v3/repos/statistics": "/en/enterprise-server@2.20/rest/reference/repos#statistics",
279279
"/en/enterprise/2.20/v3/repos/statuses": "/en/enterprise-server@2.20/rest/reference/repos#statuses",
@@ -316,7 +316,7 @@
316316
"/en/enterprise/2.21/v3/enterprise-admin/orgs": "/en/enterprise-server@2.21/rest/reference/enterprise-admin#orgs",
317317
"/en/enterprise/2.21/v3/enterprise-admin/pre_receive_environments": "/en/enterprise-server@2.21/rest/reference/enterprise-admin#pre-receive-environments",
318318
"/en/enterprise/2.21/v3/enterprise-admin/pre_receive_hooks": "/en/enterprise-server@2.21/rest/reference/enterprise-admin#pre-receive-hooks",
319-
"/en/enterprise/2.21/v3/enterprise-admin/repo_pre_receive_hooks": "/en/enterprise-server@2.21/rest/reference/enterprise-admin#repo-pre-receive-hooks",
319+
"/en/enterprise/2.21/v3/enterprise-admin/repo_pre_receive_hooks": "/en/enterprise-server@2.21/rest/reference/enterprise-admin#repository-pre-receive-hooks",
320320
"/en/enterprise/2.21/v3/enterprise-admin/search_indexing": "/en/enterprise-server@2.21/rest/reference/enterprise-admin#search-indexing",
321321
"/en/enterprise/2.21/v3/enterprise-admin/users": "/en/enterprise-server@2.21/rest/reference/enterprise-admin#users",
322322
"/en/enterprise/2.21/v3/gists/comments": "/en/enterprise-server@2.21/rest/reference/gists#comments",
@@ -340,7 +340,7 @@
340340
"/en/enterprise/2.21/v3/markdown": "/en/enterprise-server@2.21/rest/reference/markdown",
341341
"/en/enterprise/2.21/v3/meta": "/en/enterprise-server@2.21/rest/reference/meta",
342342
"/en/enterprise/2.21/v3/oauth_authorizations": "/en/enterprise-server@2.21/rest/reference/oauth-authorizations",
343-
"/en/enterprise/2.21/v3/orgs/hooks": "/en/enterprise-server@2.21/rest/reference/orgs#hooks",
343+
"/en/enterprise/2.21/v3/orgs/hooks": "/en/enterprise-server@2.21/rest/reference/orgs#webhooks",
344344
"/en/enterprise/2.21/v3/orgs": "/en/enterprise-server@2.21/rest/reference/orgs",
345345
"/en/enterprise/2.21/v3/orgs/members": "/en/enterprise-server@2.21/rest/reference/orgs#members",
346346
"/en/enterprise/2.21/v3/orgs/outside_collaborators": "/en/enterprise-server@2.21/rest/reference/orgs#outside-collaborators",
@@ -364,13 +364,13 @@
364364
"/en/enterprise/2.21/v3/repos/deployments": "/en/enterprise-server@2.21/rest/reference/repos#deployments",
365365
"/en/enterprise/2.21/v3/repos/downloads": "/en/enterprise-server@2.21/rest/reference/repos#downloads",
366366
"/en/enterprise/2.21/v3/repos/forks": "/en/enterprise-server@2.21/rest/reference/repos#forks",
367-
"/en/enterprise/2.21/v3/repos/hooks": "/en/enterprise-server@2.21/rest/reference/repos#hooks",
367+
"/en/enterprise/2.21/v3/repos/hooks": "/en/enterprise-server@2.21/rest/reference/repos#webhooks",
368368
"/en/enterprise/2.21/v3/repos": "/en/enterprise-server@2.21/rest/reference/repos",
369369
"/en/enterprise/2.21/v3/repos/invitations": "/en/enterprise-server@2.21/rest/reference/repos#invitations",
370370
"/en/enterprise/2.21/v3/repos/keys": "/en/enterprise-server@2.21/rest/reference/repos#keys",
371371
"/en/enterprise/2.21/v3/repos/merging": "/en/enterprise-server@2.21/rest/reference/repos#merging",
372372
"/en/enterprise/2.21/v3/repos/pages": "/en/enterprise-server@2.21/rest/reference/repos#pages",
373-
"/en/enterprise/2.21/v3/repos/pre_receive_hooks": "/en/enterprise-server@2.21/rest/reference/repos#pre-receive-hooks",
373+
"/en/enterprise/2.21/v3/repos/pre_receive_hooks": "/en/enterprise-server@2.21/rest/reference/enterprise-admin#repository-pre-receive-hooks",
374374
"/en/enterprise/2.21/v3/repos/releases": "/en/enterprise-server@2.21/rest/reference/repos#releases",
375375
"/en/enterprise/2.21/v3/repos/statistics": "/en/enterprise-server@2.21/rest/reference/repos#statistics",
376376
"/en/enterprise/2.21/v3/repos/statuses": "/en/enterprise-server@2.21/rest/reference/repos#statuses",
@@ -453,7 +453,7 @@
453453
"/v3/migrations/users": "/en/free-pro-team@latest/rest/reference/migrations#users",
454454
"/v3/oauth_authorizations": "/en/enterprise-server/rest/reference/oauth-authorizations",
455455
"/v3/orgs/blocking": "/en/free-pro-team@latest/rest/reference/orgs#blocking",
456-
"/v3/orgs/hooks": "/en/free-pro-team@latest/rest/reference/orgs#hooks",
456+
"/v3/orgs/hooks": "/en/free-pro-team@latest/rest/reference/orgs#webhooks",
457457
"/v3/orgs": "/en/free-pro-team@latest/rest/reference/orgs",
458458
"/v3/orgs/members": "/en/free-pro-team@latest/rest/reference/orgs#members",
459459
"/v3/orgs/migrations": "/en/free-pro-team@latest/rest/reference/orgs#migrations",
@@ -479,13 +479,13 @@
479479
"/v3/repos/deployments": "/en/free-pro-team@latest/rest/reference/repos#deployments",
480480
"/v3/repos/downloads": "/en/free-pro-team@latest/rest/reference/repos#downloads",
481481
"/v3/repos/forks": "/en/free-pro-team@latest/rest/reference/repos#forks",
482-
"/v3/repos/hooks": "/en/free-pro-team@latest/rest/reference/repos#hooks",
482+
"/v3/repos/hooks": "/en/free-pro-team@latest/rest/reference/repos#webhooks",
483483
"/v3/repos": "/en/free-pro-team@latest/rest/reference/repos",
484484
"/v3/repos/invitations": "/en/free-pro-team@latest/rest/reference/repos#invitations",
485485
"/v3/repos/keys": "/en/free-pro-team@latest/rest/reference/repos#keys",
486486
"/v3/repos/merging": "/en/free-pro-team@latest/rest/reference/repos#merging",
487487
"/v3/repos/pages": "/en/free-pro-team@latest/rest/reference/repos#pages",
488-
"/v3/repos/pre_receive_hooks": "/en/free-pro-team@latest/rest/reference/repos#pre-receive-hooks",
488+
"/v3/repos/pre_receive_hooks": "/en/enterprise-server/rest/reference/enterprise-admin#repository-pre-receive-hooks",
489489
"/v3/repos/releases": "/en/free-pro-team@latest/rest/reference/repos#releases",
490490
"/v3/repos/statistics": "/en/free-pro-team@latest/rest/reference/repos#statistics",
491491
"/v3/repos/statuses": "/en/free-pro-team@latest/rest/reference/repos#statuses",

tests/routing/developer-site-redirects.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ describe('developer redirects', () => {
126126
)
127127
})
128128

129-
// TODO temprarily ensure we redirect old links using the new enterprise format
129+
// TODO temporarily ensure we redirect old links using the new enterprise format
130130
// for currently supported enterprise releases only
131131
// EXAMPLE: /en/enterprise-server@2.20/v3/pulls/comments -> /en/enterprise-server@2.20/rest/reference/pulls#comments
132132
// We can remove test after we update all the old `/v3` links to point to `/rest`
@@ -165,7 +165,7 @@ describe('developer redirects', () => {
165165
)
166166
})
167167

168-
// TODO temprarily ensure we redirect old links using the new enterprise format
168+
// TODO temporarily ensure we redirect old links using the new enterprise format
169169
// for currently supported enterprise releases only
170170
// EXAMPLE: /en/enterprise-server@2.20/v4/interface/actor -> /en/enterprise-server@2.20/graphql/reference/interfaces#actor
171171
// We can remove test after we update all the old `/v4` links to point to `/graphql`

0 commit comments

Comments
 (0)