Skip to content

Commit edc30d6

Browse files
authored
refactor: rename codemod_permissions functions for discoverability (#22658)
1 parent c594e9f commit edc30d6

4 files changed

Lines changed: 24 additions & 24 deletions

File tree

pkg/cli/codemod_permissions_read.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import (
88

99
var permissionsReadCodemodLog = logger.New("cli:codemod_permissions_read")
1010

11-
// getPermissionsReadCodemod creates a codemod for converting invalid "read" and "write" shorthands
12-
func getPermissionsReadCodemod() Codemod {
11+
// getExpandPermissionsShorthandCodemod creates a codemod for converting invalid "read" and "write" shorthands
12+
func getExpandPermissionsShorthandCodemod() Codemod {
1313
return Codemod{
1414
ID: "permissions-read-to-read-all",
1515
Name: "Convert invalid permissions shorthand",

pkg/cli/codemod_permissions_test.go

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
)
1111

1212
func TestGetPermissionsReadCodemod(t *testing.T) {
13-
codemod := getPermissionsReadCodemod()
13+
codemod := getExpandPermissionsShorthandCodemod()
1414

1515
assert.Equal(t, "permissions-read-to-read-all", codemod.ID)
1616
assert.Equal(t, "Convert invalid permissions shorthand", codemod.Name)
@@ -20,7 +20,7 @@ func TestGetPermissionsReadCodemod(t *testing.T) {
2020
}
2121

2222
func TestPermissionsReadCodemod_Read(t *testing.T) {
23-
codemod := getPermissionsReadCodemod()
23+
codemod := getExpandPermissionsShorthandCodemod()
2424

2525
content := `---
2626
on: workflow_dispatch
@@ -43,7 +43,7 @@ permissions: read
4343
}
4444

4545
func TestPermissionsReadCodemod_Write(t *testing.T) {
46-
codemod := getPermissionsReadCodemod()
46+
codemod := getExpandPermissionsShorthandCodemod()
4747

4848
content := `---
4949
on: workflow_dispatch
@@ -66,7 +66,7 @@ permissions: write
6666
}
6767

6868
func TestPermissionsReadCodemod_NoChange_ReadAll(t *testing.T) {
69-
codemod := getPermissionsReadCodemod()
69+
codemod := getExpandPermissionsShorthandCodemod()
7070

7171
content := `---
7272
on: workflow_dispatch
@@ -88,7 +88,7 @@ permissions: read-all
8888
}
8989

9090
func TestPermissionsReadCodemod_NoChange_WriteAll(t *testing.T) {
91-
codemod := getPermissionsReadCodemod()
91+
codemod := getExpandPermissionsShorthandCodemod()
9292

9393
content := `---
9494
on: workflow_dispatch
@@ -110,7 +110,7 @@ permissions: write-all
110110
}
111111

112112
func TestPermissionsReadCodemod_NoChange_MapFormat(t *testing.T) {
113-
codemod := getPermissionsReadCodemod()
113+
codemod := getExpandPermissionsShorthandCodemod()
114114

115115
content := `---
116116
on: workflow_dispatch
@@ -137,7 +137,7 @@ permissions:
137137
}
138138

139139
func TestPermissionsReadCodemod_NoPermissions(t *testing.T) {
140-
codemod := getPermissionsReadCodemod()
140+
codemod := getExpandPermissionsShorthandCodemod()
141141

142142
content := `---
143143
on: workflow_dispatch
@@ -159,7 +159,7 @@ timeout-minutes: 30
159159
}
160160

161161
func TestPermissionsReadCodemod_PreservesMarkdown(t *testing.T) {
162-
codemod := getPermissionsReadCodemod()
162+
codemod := getExpandPermissionsShorthandCodemod()
163163

164164
content := `---
165165
on: workflow_dispatch
@@ -184,7 +184,7 @@ This workflow needs permissions.`
184184
}
185185

186186
func TestGetWritePermissionsCodemod(t *testing.T) {
187-
codemod := getWritePermissionsCodemod()
187+
codemod := getMigrateWritePermissionsToReadCodemod()
188188

189189
assert.Equal(t, "write-permissions-to-read-migration", codemod.ID)
190190
assert.Equal(t, "Convert write permissions to read", codemod.Name)
@@ -194,7 +194,7 @@ func TestGetWritePermissionsCodemod(t *testing.T) {
194194
}
195195

196196
func TestWritePermissionsCodemod_ShorthandWriteAll(t *testing.T) {
197-
codemod := getWritePermissionsCodemod()
197+
codemod := getMigrateWritePermissionsToReadCodemod()
198198

199199
content := `---
200200
on: workflow_dispatch
@@ -217,7 +217,7 @@ permissions: write-all
217217
}
218218

219219
func TestWritePermissionsCodemod_ShorthandWrite(t *testing.T) {
220-
codemod := getWritePermissionsCodemod()
220+
codemod := getMigrateWritePermissionsToReadCodemod()
221221

222222
content := `---
223223
on: workflow_dispatch
@@ -240,7 +240,7 @@ permissions: write
240240
}
241241

242242
func TestWritePermissionsCodemod_MapFormat(t *testing.T) {
243-
codemod := getWritePermissionsCodemod()
243+
codemod := getMigrateWritePermissionsToReadCodemod()
244244

245245
content := `---
246246
on: workflow_dispatch
@@ -269,7 +269,7 @@ permissions:
269269
}
270270

271271
func TestWritePermissionsCodemod_MultipleWritePermissions(t *testing.T) {
272-
codemod := getWritePermissionsCodemod()
272+
codemod := getMigrateWritePermissionsToReadCodemod()
273273

274274
content := `---
275275
on: workflow_dispatch
@@ -300,7 +300,7 @@ permissions:
300300
}
301301

302302
func TestWritePermissionsCodemod_NoPermissionsField(t *testing.T) {
303-
codemod := getWritePermissionsCodemod()
303+
codemod := getMigrateWritePermissionsToReadCodemod()
304304

305305
content := `---
306306
on: workflow_dispatch
@@ -322,7 +322,7 @@ timeout-minutes: 30
322322
}
323323

324324
func TestWritePermissionsCodemod_OnlyReadPermissions(t *testing.T) {
325-
codemod := getWritePermissionsCodemod()
325+
codemod := getMigrateWritePermissionsToReadCodemod()
326326

327327
content := `---
328328
on: workflow_dispatch
@@ -349,7 +349,7 @@ permissions:
349349
}
350350

351351
func TestWritePermissionsCodemod_PreservesIndentation(t *testing.T) {
352-
codemod := getWritePermissionsCodemod()
352+
codemod := getMigrateWritePermissionsToReadCodemod()
353353

354354
content := `---
355355
on: workflow_dispatch
@@ -377,7 +377,7 @@ permissions:
377377
}
378378

379379
func TestWritePermissionsCodemod_PreservesComments(t *testing.T) {
380-
codemod := getWritePermissionsCodemod()
380+
codemod := getMigrateWritePermissionsToReadCodemod()
381381

382382
content := `---
383383
on: workflow_dispatch
@@ -405,7 +405,7 @@ permissions:
405405
}
406406

407407
func TestWritePermissionsCodemod_PreservesMarkdown(t *testing.T) {
408-
codemod := getWritePermissionsCodemod()
408+
codemod := getMigrateWritePermissionsToReadCodemod()
409409

410410
content := `---
411411
on: workflow_dispatch

pkg/cli/codemod_permissions_write.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import (
99

1010
var writePermissionsCodemodLog = logger.New("cli:codemod_permissions")
1111

12-
// getWritePermissionsCodemod creates a codemod for converting write permissions to read
13-
func getWritePermissionsCodemod() Codemod {
12+
// getMigrateWritePermissionsToReadCodemod creates a codemod for converting write permissions to read
13+
func getMigrateWritePermissionsToReadCodemod() Codemod {
1414
return Codemod{
1515
ID: "write-permissions-to-read-migration",
1616
Name: "Convert write permissions to read",

pkg/cli/fix_codemods.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ func GetAllCodemods() []Codemod {
2727
getCommandToSlashCommandCodemod(),
2828
getMCPScriptsModeCodemod(),
2929
getUploadAssetsCodemod(),
30-
getWritePermissionsCodemod(),
31-
getPermissionsReadCodemod(), // Fix permissions: read -> permissions: read-all
30+
getMigrateWritePermissionsToReadCodemod(),
31+
getExpandPermissionsShorthandCodemod(), // Fix permissions: read -> permissions: read-all
3232
getAgentTaskToAgentSessionCodemod(),
3333
getSandboxFalseToAgentFalseCodemod(), // Convert sandbox: false to sandbox.agent: false
3434
getScheduleAtToAroundCodemod(),

0 commit comments

Comments
 (0)