forked from JamesIves/github-pages-deploy-action
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgit.ts
More file actions
334 lines (299 loc) · 9.42 KB
/
Copy pathgit.ts
File metadata and controls
334 lines (299 loc) · 9.42 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
import {info} from '@actions/core'
import {mkdirP, rmRF} from '@actions/io'
import fs from 'fs'
import {ActionInterface, Status} from './constants'
import {execute} from './execute'
import {isNullOrUndefined, suppressSensitiveInformation} from './util'
/* Initializes git in the workspace. */
export async function init(action: ActionInterface): Promise<void | Error> {
try {
info(`Deploying using ${action.tokenType}… 🔑`)
info('Configuring git…')
await execute(`git init`, action.workspace, action.silent)
await execute(
`git config user.name "${action.name}"`,
action.workspace,
action.silent
)
await execute(
`git config user.email "${action.email}"`,
action.workspace,
action.silent
)
try {
await execute(`git remote rm origin`, action.workspace, action.silent)
if (action.isTest) {
throw new Error()
}
} catch {
info('Attempted to remove origin but failed, continuing…')
}
await execute(
`git remote add origin ${action.repositoryPath}`,
action.workspace,
action.silent
)
if (action.preserve) {
info(`Stashing workspace changes… ⬆️`)
await execute(`git stash`, action.workspace, action.silent)
}
await execute(
`git fetch --no-recurse-submodules`,
action.workspace,
action.silent
)
info('Git configured… 🔧')
} catch (error) {
throw new Error(
`There was an error initializing the repository: ${suppressSensitiveInformation(
error.message,
action
)} ❌`
)
}
}
/* Switches to the base branch. */
export async function switchToBaseBranch(
action: ActionInterface
): Promise<void> {
try {
await execute(
`git checkout --progress --force ${
action.baseBranch ? action.baseBranch : action.defaultBranch
}`,
action.workspace,
action.silent
)
} catch (error) {
throw new Error(
`There was an error switching to the base branch: ${suppressSensitiveInformation(
error.message,
action
)} ❌`
)
}
}
/* Generates the branch if it doesn't exist on the remote. */
export async function generateBranch(action: ActionInterface): Promise<void> {
try {
info(`Creating the ${action.branch} branch…`)
await switchToBaseBranch(action)
await execute(
`git checkout --orphan ${action.branch}`,
action.workspace,
action.silent
)
await execute(`git reset --hard`, action.workspace, action.silent)
await execute(
`git commit --no-verify --allow-empty -m "Initial ${action.branch} commit"`,
action.workspace,
action.silent
)
await execute(
`git push --force ${action.repositoryPath} ${action.branch}`,
action.workspace,
action.silent
)
await execute(`git fetch`, action.workspace, action.silent)
info(`Created the ${action.branch} branch… 🔧`)
} catch (error) {
throw new Error(
`There was an error creating the deployment branch: ${suppressSensitiveInformation(
error.message,
action
)} ❌`
)
}
}
/* Runs the necessary steps to make the deployment. */
export async function deploy(action: ActionInterface): Promise<Status> {
const temporaryDeploymentDirectory =
'github-pages-deploy-action-temp-deployment-folder'
const temporaryDeploymentBranch = `github-pages-deploy-action/${Math.random()
.toString(36)
.substr(2, 9)}`
info('Starting to commit changes…')
try {
const commitMessage = !isNullOrUndefined(action.commitMessage)
? (action.commitMessage as string)
: `Deploying to ${action.branch} from ${action.baseBranch} ${
process.env.GITHUB_SHA ? `@ ${process.env.GITHUB_SHA}` : ''
} 🚀`
/*
Checks to see if the remote exists prior to deploying.
If the branch doesn't exist it gets created here as an orphan.
*/
const branchExists = await execute(
`git ls-remote --heads ${action.repositoryPath} ${action.branch} | wc -l`,
action.workspace,
action.silent
)
if (!branchExists && !action.isTest) {
await generateBranch(action)
}
// Checks out the base branch to begin the deployment process.
await switchToBaseBranch(action)
await execute(
`git fetch ${action.repositoryPath}`,
action.workspace,
action.silent
)
if (action.lfs) {
// Migrates data from LFS so it can be comitted the "normal" way.
info(`Migrating from Git LFS… ⚓`)
await execute(
`git lfs migrate export --include="*" --yes`,
action.workspace,
action.silent
)
}
if (action.preserve) {
info(`Applying stashed workspace changes… ⬆️`)
try {
await execute(`git stash apply`, action.workspace, action.silent)
} catch {
info('Unable to apply from stash, continuing…')
}
}
await execute(
`git worktree add --checkout ${temporaryDeploymentDirectory} origin/${action.branch}`,
action.workspace,
action.silent
)
// Ensures that items that need to be excluded from the clean job get parsed.
let excludes = ''
if (action.clean && action.cleanExclude) {
try {
const excludedItems =
typeof action.cleanExclude === 'string'
? JSON.parse(action.cleanExclude)
: action.cleanExclude
for (const item of excludedItems) {
excludes += `--exclude ${item} `
}
} catch {
info(
'There was an error parsing your CLEAN_EXCLUDE items. Please refer to the README for more details. ❌'
)
}
}
if (action.targetFolder) {
info(`Creating target folder if it doesn't already exist… 📌`)
await mkdirP(`${temporaryDeploymentDirectory}/${action.targetFolder}`)
}
/*
Pushes all of the build files into the deployment directory.
Allows the user to specify the root if '.' is provided.
rsync is used to prevent file duplication. */
await execute(
`rsync -q -av --checksum --progress ${action.folderPath}/. ${
action.targetFolder
? `${temporaryDeploymentDirectory}/${action.targetFolder}`
: temporaryDeploymentDirectory
} ${
action.clean
? `--delete ${excludes} ${
!fs.existsSync(`${action.folderPath}/CNAME`)
? '--exclude CNAME'
: ''
} ${
!fs.existsSync(`${action.folderPath}/.nojekyll`)
? '--exclude .nojekyll'
: ''
}`
: ''
} --exclude .ssh --exclude .git --exclude .github ${
action.folderPath === action.workspace
? `--exclude ${temporaryDeploymentDirectory}`
: ''
}`,
action.workspace,
action.silent
)
const hasFilesToCommit = await execute(
`git status --porcelain`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
if (!hasFilesToCommit && !action.isTest) {
return Status.SKIPPED
}
// Commits to GitHub.
await execute(
`git add --all .`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
await execute(
`git checkout -b ${temporaryDeploymentBranch}`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
await execute(
`git commit -m "${commitMessage}" --quiet --no-verify`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
await execute(
`git push --force ${action.repositoryPath} ${temporaryDeploymentBranch}:${action.branch}`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
info(`Changes committed to the ${action.branch} branch… 📦`)
if (action.singleCommit) {
await execute(
`git fetch ${action.repositoryPath}`,
action.workspace,
action.silent
)
await execute(
`git checkout --orphan ${action.branch}-temp`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
await execute(
`git add --all .`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
await execute(
`git commit -m "${commitMessage}" --quiet --no-verify`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
await execute(
`git branch -M ${action.branch}-temp ${action.branch}`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
await execute(
`git push origin ${action.branch} --force`,
`${action.workspace}/${temporaryDeploymentDirectory}`,
action.silent
)
info('Cleared git history… 🚿')
}
await execute(
`git checkout --progress --force ${action.defaultBranch}`,
action.workspace,
action.silent
)
return Status.SUCCESS
} catch (error) {
throw new Error(
`The deploy step encountered an error: ${suppressSensitiveInformation(
error.message,
action
)} ❌`
)
} finally {
// Cleans up temporary files/folders and restores the git state.
info('Running post deployment cleanup jobs… 🗑️')
await execute(
`git worktree remove ${temporaryDeploymentDirectory} --force`,
action.workspace,
action.silent
)
await rmRF(temporaryDeploymentDirectory)
}
}