Skip to content

refactor: rename codemod_permissions functions for discoverability #22658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 2 commits into from
Mar 24, 2026
+24 −24
Merged

refactor: rename codemod_permissions functions for discoverability #22658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48589e1
Initial plan
Copilot Mar 24, 2026
9461ae3
refactor: rename getPermissionsReadCodemod and getWritePermissionsCod…
Copilot Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pkg/cli/codemod_permissions_read.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import (

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

// getPermissionsReadCodemod creates a codemod for converting invalid "read" and "write" shorthands
func getPermissionsReadCodemod() Codemod {
// getExpandPermissionsShorthandCodemod creates a codemod for converting invalid "read" and "write" shorthands
func getExpandPermissionsShorthandCodemod() Codemod {
return Codemod{
ID: "permissions-read-to-read-all",
Name: "Convert invalid permissions shorthand",
Expand Down
36 changes: 18 additions & 18 deletions pkg/cli/codemod_permissions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
)

func TestGetPermissionsReadCodemod(t *testing.T) {
codemod := getPermissionsReadCodemod()
codemod := getExpandPermissionsShorthandCodemod()
Comment on lines 12 to +13
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These test names still refer to the old codemod name (e.g., TestGetPermissionsReadCodemod / TestPermissionsReadCodemod_*) even though they now exercise getExpandPermissionsShorthandCodemod. Renaming the test functions to match the new codemod name will keep grep/search-based discoverability consistent with the refactor goal.

This issue also appears on line 186 of the same file.

Copilot uses AI. Check for mistakes.

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

func TestPermissionsReadCodemod_Read(t *testing.T) {
codemod := getPermissionsReadCodemod()
codemod := getExpandPermissionsShorthandCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -43,7 +43,7 @@ permissions: read
}

func TestPermissionsReadCodemod_Write(t *testing.T) {
codemod := getPermissionsReadCodemod()
codemod := getExpandPermissionsShorthandCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -66,7 +66,7 @@ permissions: write
}

func TestPermissionsReadCodemod_NoChange_ReadAll(t *testing.T) {
codemod := getPermissionsReadCodemod()
codemod := getExpandPermissionsShorthandCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -88,7 +88,7 @@ permissions: read-all
}

func TestPermissionsReadCodemod_NoChange_WriteAll(t *testing.T) {
codemod := getPermissionsReadCodemod()
codemod := getExpandPermissionsShorthandCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -110,7 +110,7 @@ permissions: write-all
}

func TestPermissionsReadCodemod_NoChange_MapFormat(t *testing.T) {
codemod := getPermissionsReadCodemod()
codemod := getExpandPermissionsShorthandCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -137,7 +137,7 @@ permissions:
}

func TestPermissionsReadCodemod_NoPermissions(t *testing.T) {
codemod := getPermissionsReadCodemod()
codemod := getExpandPermissionsShorthandCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -159,7 +159,7 @@ timeout-minutes: 30
}

func TestPermissionsReadCodemod_PreservesMarkdown(t *testing.T) {
codemod := getPermissionsReadCodemod()
codemod := getExpandPermissionsShorthandCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -184,7 +184,7 @@ This workflow needs permissions.`
}

func TestGetWritePermissionsCodemod(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

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

func TestWritePermissionsCodemod_ShorthandWriteAll(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -217,7 +217,7 @@ permissions: write-all
}

func TestWritePermissionsCodemod_ShorthandWrite(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -240,7 +240,7 @@ permissions: write
}

func TestWritePermissionsCodemod_MapFormat(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

content := `---
on: workflow_dispatch
Expand Down Expand Up @@ -269,7 +269,7 @@ permissions:
}

func TestWritePermissionsCodemod_MultipleWritePermissions(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

content := `---
on: workflow_dispatch
Expand Down Expand Up @@ -300,7 +300,7 @@ permissions:
}

func TestWritePermissionsCodemod_NoPermissionsField(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -322,7 +322,7 @@ timeout-minutes: 30
}

func TestWritePermissionsCodemod_OnlyReadPermissions(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

content := `---
on: workflow_dispatch
Expand All @@ -349,7 +349,7 @@ permissions:
}

func TestWritePermissionsCodemod_PreservesIndentation(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

content := `---
on: workflow_dispatch
Expand Down Expand Up @@ -377,7 +377,7 @@ permissions:
}

func TestWritePermissionsCodemod_PreservesComments(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

content := `---
on: workflow_dispatch
Expand Down Expand Up @@ -405,7 +405,7 @@ permissions:
}

func TestWritePermissionsCodemod_PreservesMarkdown(t *testing.T) {
codemod := getWritePermissionsCodemod()
codemod := getMigrateWritePermissionsToReadCodemod()

content := `---
on: workflow_dispatch
Expand Down
4 changes: 2 additions & 2 deletions pkg/cli/codemod_permissions_write.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import (

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

// getWritePermissionsCodemod creates a codemod for converting write permissions to read
func getWritePermissionsCodemod() Codemod {
// getMigrateWritePermissionsToReadCodemod creates a codemod for converting write permissions to read
func getMigrateWritePermissionsToReadCodemod() Codemod {
return Codemod{
ID: "write-permissions-to-read-migration",
Name: "Convert write permissions to read",
Expand Down
4 changes: 2 additions & 2 deletions pkg/cli/fix_codemods.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ func GetAllCodemods() []Codemod {
getCommandToSlashCommandCodemod(),
getMCPScriptsModeCodemod(),
getUploadAssetsCodemod(),
getWritePermissionsCodemod(),
getPermissionsReadCodemod(), // Fix permissions: read -> permissions: read-all
getMigrateWritePermissionsToReadCodemod(),
getExpandPermissionsShorthandCodemod(), // Fix permissions: read -> permissions: read-all
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The inline comment still describes only the read shorthand, but this codemod also expands permissions: write → permissions: write-all (per its description). Update the comment to reflect both cases (or describe it generically as expanding invalid permissions shorthands) to avoid misleading future readers/searches.

Suggested change
getExpandPermissionsShorthandCodemod(), // Fix permissions: read -> permissions: read-all
getExpandPermissionsShorthandCodemod(), // Expand invalid permissions shorthands (e.g., read -> read-all, write -> write-all)

Copilot uses AI. Check for mistakes.
getAgentTaskToAgentSessionCodemod(),
getSandboxFalseToAgentFalseCodemod(), // Convert sandbox: false to sandbox.agent: false
getScheduleAtToAroundCodemod(),
Expand Down
Loading