Skip to content

Commit 7fec4b2

Browse files
authored
Merge pull request #136 from actions/update-api-routes
Update the deployment API endpoints used by the api-client module
2 parents e690f03 + 73594fd commit 7fec4b2

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

dist/index.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -9899,7 +9899,7 @@ async function createPagesDeployment({ githubToken, artifactUrl, buildVersion, i
98999899
core.info(`Creating Pages deployment with payload:\n${JSON.stringify(payload, null, '\t')}`)
99009900

99019901
try {
9902-
const response = await octokit.request('POST /repos/{owner}/{repo}/pages/deployment', {
9902+
const response = await octokit.request('POST /repos/{owner}/{repo}/pages/deployments', {
99039903
owner: github.context.repo.owner,
99049904
repo: github.context.repo.repo,
99059905
...payload
@@ -9917,7 +9917,7 @@ async function getPagesDeploymentStatus({ githubToken, deploymentId }) {
99179917

99189918
core.info('Getting Pages deployment status...')
99199919
try {
9920-
const response = await octokit.request('GET /repos/{owner}/{repo}/pages/deployment/status/{deploymentId}', {
9920+
const response = await octokit.request('GET /repos/{owner}/{repo}/pages/deployments/{deploymentId}', {
99219921
owner: github.context.repo.owner,
99229922
repo: github.context.repo.repo,
99239923
deploymentId
@@ -9935,7 +9935,7 @@ async function cancelPagesDeployment({ githubToken, deploymentId }) {
99359935

99369936
core.info('Canceling Pages deployment...')
99379937
try {
9938-
const response = await octokit.request('PUT /repos/{owner}/{repo}/pages/deployment/cancel/{deploymentId}', {
9938+
const response = await octokit.request('POST /repos/{owner}/{repo}/pages/deployments/{deploymentId}/cancel', {
99399939
owner: github.context.repo.owner,
99409940
repo: github.context.repo.repo,
99419941
deploymentId

dist/index.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/api-client.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ async function createPagesDeployment({ githubToken, artifactUrl, buildVersion, i
113113
core.info(`Creating Pages deployment with payload:\n${JSON.stringify(payload, null, '\t')}`)
114114

115115
try {
116-
const response = await octokit.request('POST /repos/{owner}/{repo}/pages/deployment', {
116+
const response = await octokit.request('POST /repos/{owner}/{repo}/pages/deployments', {
117117
owner: github.context.repo.owner,
118118
repo: github.context.repo.repo,
119119
...payload
@@ -131,7 +131,7 @@ async function getPagesDeploymentStatus({ githubToken, deploymentId }) {
131131

132132
core.info('Getting Pages deployment status...')
133133
try {
134-
const response = await octokit.request('GET /repos/{owner}/{repo}/pages/deployment/status/{deploymentId}', {
134+
const response = await octokit.request('GET /repos/{owner}/{repo}/pages/deployments/{deploymentId}', {
135135
owner: github.context.repo.owner,
136136
repo: github.context.repo.repo,
137137
deploymentId
@@ -149,7 +149,7 @@ async function cancelPagesDeployment({ githubToken, deploymentId }) {
149149

150150
core.info('Canceling Pages deployment...')
151151
try {
152-
const response = await octokit.request('PUT /repos/{owner}/{repo}/pages/deployment/cancel/{deploymentId}', {
152+
const response = await octokit.request('POST /repos/{owner}/{repo}/pages/deployments/{deploymentId}/cancel', {
153153
owner: github.context.repo.owner,
154154
repo: github.context.repo.repo,
155155
deploymentId

src/index.test.js

+11-11
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,13 @@ describe('Deployment', () => {
100100
})
101101

102102
const createDeploymentScope = nock('https://api.github.com')
103-
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment`, {
103+
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments`, {
104104
artifact_url: 'https://fake-artifact.com&%24expand=SignedContent',
105105
pages_build_version: process.env.GITHUB_SHA,
106106
oidc_token: fakeJwt
107107
})
108108
.reply(200, {
109-
status_url: `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment/status/${process.env.GITHUB_SHA}`,
109+
status_url: `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments/${process.env.GITHUB_SHA}`,
110110
page_url: 'https://actions.github.io/is-awesome'
111111
})
112112

@@ -138,14 +138,14 @@ describe('Deployment', () => {
138138
})
139139

140140
const createDeploymentScope = nock('https://api.github.com')
141-
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment`, {
141+
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments`, {
142142
artifact_url: 'https://fake-artifact.com&%24expand=SignedContent',
143143
pages_build_version: process.env.GITHUB_SHA,
144144
oidc_token: fakeJwt,
145145
preview: true
146146
})
147147
.reply(200, {
148-
status_url: `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment/status/${process.env.GITHUB_SHA}`,
148+
status_url: `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments/${process.env.GITHUB_SHA}`,
149149
page_url: 'https://actions.github.io/is-awesome',
150150
preview_url: 'https://actions.drafts.github.io/is-awesome'
151151
})
@@ -192,7 +192,7 @@ describe('Deployment', () => {
192192
.reply(200, { value: [{ url: 'https://invalid-artifact.com', name: 'github-pages' }] })
193193

194194
const createDeploymentScope = nock('https://api.github.com')
195-
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment`, {
195+
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments`, {
196196
artifact_url: 'https://invalid-artifact.com&%24expand=SignedContent',
197197
pages_build_version: process.env.GITHUB_SHA
198198
})
@@ -225,18 +225,18 @@ describe('Deployment', () => {
225225
})
226226

227227
const createDeploymentScope = nock('https://api.github.com')
228-
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment`, {
228+
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments`, {
229229
artifact_url: 'https://fake-artifact.com&%24expand=SignedContent',
230230
pages_build_version: process.env.GITHUB_SHA,
231231
oidc_token: fakeJwt
232232
})
233233
.reply(200, {
234-
status_url: `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment/status/${process.env.GITHUB_SHA}`,
234+
status_url: `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments/${process.env.GITHUB_SHA}`,
235235
page_url: 'https://actions.github.io/is-awesome'
236236
})
237237

238238
const deploymentStatusScope = nock('https://api.github.com')
239-
.get(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment/status/${process.env.GITHUB_SHA}`)
239+
.get(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments/${process.env.GITHUB_SHA}`)
240240
.reply(200, {
241241
status: 'succeed'
242242
})
@@ -279,18 +279,18 @@ describe('Deployment', () => {
279279
})
280280

281281
const createDeploymentScope = nock('https://api.github.com')
282-
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment`, {
282+
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments`, {
283283
artifact_url: 'https://fake-artifact.com&%24expand=SignedContent',
284284
pages_build_version: process.env.GITHUB_SHA,
285285
oidc_token: fakeJwt
286286
})
287287
.reply(200, {
288-
status_url: `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment/status/${process.env.GITHUB_SHA}`,
288+
status_url: `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments/${process.env.GITHUB_SHA}`,
289289
page_url: 'https://actions.github.io/is-awesome'
290290
})
291291

292292
const cancelDeploymentScope = nock('https://api.github.com')
293-
.put(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployment/cancel/${process.env.GITHUB_SHA}`)
293+
.post(`/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments/${process.env.GITHUB_SHA}/cancel`)
294294
.reply(200, {})
295295

296296
core.getIDToken = jest.fn().mockResolvedValue(fakeJwt)

0 commit comments

Comments
 (0)