Skip to content

Add --dir flag to specify subfolder for workflow installation #3459

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
merged 3 commits into from
Nov 7, 2025
Merged

Add --dir flag to specify subfolder for workflow installation #3459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10440ce
Initial plan
Copilot Nov 7, 2025
375ea9d
Initial exploration complete
Copilot Nov 7, 2025
0e42019
Add --dir flag to add command for subfolder support
Copilot Nov 7, 2025
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
1 change: 0 additions & 1 deletion .github/workflows/super-linter-report.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

54 changes: 40 additions & 14 deletions pkg/cli/add_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Examples:
` + constants.CLIExtensionPrefix + ` add githubnext/agentics/ci-doctor --pr --force
` + constants.CLIExtensionPrefix + ` add githubnext/agentics/*
` + constants.CLIExtensionPrefix + ` add githubnext/agentics/*@v1.0.0
` + constants.CLIExtensionPrefix + ` add githubnext/agentics/ci-doctor --dir shared # Add to .github/workflows/shared/

Workflow specifications:
- Two parts: "owner/repo[@version]" (lists available workflows in the repository)
Expand All @@ -44,6 +45,7 @@ Workflow specifications:
- Version can be tag, branch, or SHA

The -n flag allows you to specify a custom name for the workflow file (only applies to the first workflow when adding multiple).
The --dir flag allows you to specify a subdirectory under .github/workflows/ where the workflow will be added.
The --pr flag automatically creates a pull request with the workflow changes.
The --force flag overwrites existing workflow files.`,
Run: func(cmd *cobra.Command, args []string) {
Expand All @@ -56,6 +58,7 @@ The --force flag overwrites existing workflow files.`,
appendText, _ := cmd.Flags().GetString("append")
verbose, _ := cmd.Flags().GetBool("verbose")
noGitattributes, _ := cmd.Flags().GetBool("no-gitattributes")
workflowDir, _ := cmd.Flags().GetString("dir")

// If no arguments provided and not in CI, automatically use interactive mode
if len(args) == 0 && !IsRunningInCI() {
Expand All @@ -76,12 +79,12 @@ The --force flag overwrites existing workflow files.`,

// Handle normal mode
if prFlag {
if err := AddWorkflows(workflows, numberFlag, verbose, engineOverride, nameFlag, forceFlag, appendText, true, noGitattributes); err != nil {
if err := AddWorkflows(workflows, numberFlag, verbose, engineOverride, nameFlag, forceFlag, appendText, true, noGitattributes, workflowDir); err != nil {
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(err.Error()))
os.Exit(1)
}
} else {
if err := AddWorkflows(workflows, numberFlag, verbose, engineOverride, nameFlag, forceFlag, appendText, false, noGitattributes); err != nil {
if err := AddWorkflows(workflows, numberFlag, verbose, engineOverride, nameFlag, forceFlag, appendText, false, noGitattributes, workflowDir); err != nil {
fmt.Fprintln(os.Stderr, console.FormatErrorMessage(err.Error()))
os.Exit(1)
}
Expand Down Expand Up @@ -113,13 +116,16 @@ The --force flag overwrites existing workflow files.`,
// Add no-gitattributes flag to add command
cmd.Flags().Bool("no-gitattributes", false, "Skip updating .gitattributes file")

// Add workflow directory flag to add command
cmd.Flags().StringP("dir", "d", "", "Specify subdirectory under .github/workflows/ (e.g., 'shared' for .github/workflows/shared/)")

return cmd
}

// AddWorkflows adds one or more workflows from components to .github/workflows
// with optional repository installation and PR creation
func AddWorkflows(workflows []string, number int, verbose bool, engineOverride string, name string, force bool, appendText string, createPR bool, noGitattributes bool) error {
addLog.Printf("Adding workflows: count=%d, engineOverride=%s, createPR=%v, noGitattributes=%v", len(workflows), engineOverride, createPR, noGitattributes)
func AddWorkflows(workflows []string, number int, verbose bool, engineOverride string, name string, force bool, appendText string, createPR bool, noGitattributes bool, workflowDir string) error {
addLog.Printf("Adding workflows: count=%d, engineOverride=%s, createPR=%v, noGitattributes=%v, workflowDir=%s", len(workflows), engineOverride, createPR, noGitattributes, workflowDir)

if len(workflows) == 0 {
return fmt.Errorf("at least one workflow name is required")
Expand Down Expand Up @@ -232,12 +238,12 @@ func AddWorkflows(workflows []string, number int, verbose bool, engineOverride s
// Handle PR creation workflow
if createPR {
addLog.Print("Creating workflow with PR")
return addWorkflowsWithPR(processedWorkflows, number, verbose, engineOverride, name, force, appendText, noGitattributes, hasWildcard)
return addWorkflowsWithPR(processedWorkflows, number, verbose, engineOverride, name, force, appendText, noGitattributes, hasWildcard, workflowDir)
}

// Handle normal workflow addition
addLog.Print("Adding workflows normally without PR")
return addWorkflowsNormal(processedWorkflows, number, verbose, engineOverride, name, force, appendText, noGitattributes, hasWildcard)
return addWorkflowsNormal(processedWorkflows, number, verbose, engineOverride, name, force, appendText, noGitattributes, hasWildcard, workflowDir)
}

// handleRepoOnlySpec handles the case when user provides only owner/repo without workflow name
Expand Down Expand Up @@ -338,7 +344,7 @@ func displayAvailableWorkflows(repoSlug, version string, verbose bool) error {
}

// addWorkflowsNormal handles normal workflow addition without PR creation
func addWorkflowsNormal(workflows []*WorkflowSpec, number int, verbose bool, engineOverride string, name string, force bool, appendText string, noGitattributes bool, fromWildcard bool) error {
func addWorkflowsNormal(workflows []*WorkflowSpec, number int, verbose bool, engineOverride string, name string, force bool, appendText string, noGitattributes bool, fromWildcard bool, workflowDir string) error {
// Create file tracker for all operations
tracker, err := NewFileTracker()
if err != nil {
Expand Down Expand Up @@ -379,7 +385,7 @@ func addWorkflowsNormal(workflows []*WorkflowSpec, number int, verbose bool, eng
currentName = name
}

if err := addWorkflowWithTracking(workflow, number, verbose, engineOverride, currentName, force, appendText, tracker, fromWildcard); err != nil {
if err := addWorkflowWithTracking(workflow, number, verbose, engineOverride, currentName, force, appendText, tracker, fromWildcard, workflowDir); err != nil {
return fmt.Errorf("failed to add workflow '%s': %w", workflow.String(), err)
}
}
Expand All @@ -392,7 +398,7 @@ func addWorkflowsNormal(workflows []*WorkflowSpec, number int, verbose bool, eng
}

// addWorkflowsWithPR handles workflow addition with PR creation
func addWorkflowsWithPR(workflows []*WorkflowSpec, number int, verbose bool, engineOverride string, name string, force bool, appendText string, noGitattributes bool, fromWildcard bool) error {
func addWorkflowsWithPR(workflows []*WorkflowSpec, number int, verbose bool, engineOverride string, name string, force bool, appendText string, noGitattributes bool, fromWildcard bool, workflowDir string) error {
// Get current branch for restoration later
currentBranch, err := getCurrentBranch()
if err != nil {
Expand Down Expand Up @@ -421,7 +427,7 @@ func addWorkflowsWithPR(workflows []*WorkflowSpec, number int, verbose bool, eng
}()

// Add workflows using the normal function logic
if err := addWorkflowsNormal(workflows, number, verbose, engineOverride, name, force, appendText, noGitattributes, fromWildcard); err != nil {
if err := addWorkflowsNormal(workflows, number, verbose, engineOverride, name, force, appendText, noGitattributes, fromWildcard, workflowDir); err != nil {
// Rollback on error
if rollbackErr := tracker.RollbackAllFiles(verbose); rollbackErr != nil && verbose {
fmt.Fprintln(os.Stderr, console.FormatWarningMessage(fmt.Sprintf("Failed to rollback files: %v", rollbackErr)))
Expand Down Expand Up @@ -500,7 +506,7 @@ func addWorkflowsWithPR(workflows []*WorkflowSpec, number int, verbose bool, eng
}

// addWorkflowWithTracking adds a workflow from components to .github/workflows with file tracking
func addWorkflowWithTracking(workflow *WorkflowSpec, number int, verbose bool, engineOverride string, name string, force bool, appendText string, tracker *FileTracker, fromWildcard bool) error {
func addWorkflowWithTracking(workflow *WorkflowSpec, number int, verbose bool, engineOverride string, name string, force bool, appendText string, tracker *FileTracker, fromWildcard bool, workflowDir string) error {
if verbose {
fmt.Fprintln(os.Stderr, console.FormatInfoMessage(fmt.Sprintf("Adding workflow: %s", workflow.String())))
fmt.Fprintln(os.Stderr, console.FormatInfoMessage(fmt.Sprintf("Number of copies: %d", number)))
Expand Down Expand Up @@ -555,10 +561,30 @@ func addWorkflowWithTracking(workflow *WorkflowSpec, number int, verbose bool, e
return fmt.Errorf("add workflow requires being in a git repository: %w", err)
}

// Ensure .github/workflows directory exists relative to git root
githubWorkflowsDir := filepath.Join(gitRoot, ".github/workflows")
// Determine the target workflow directory
var githubWorkflowsDir string
if workflowDir != "" {
// Validate that the path is relative
if filepath.IsAbs(workflowDir) {
return fmt.Errorf("workflow directory must be a relative path, got: %s", workflowDir)
}
// Clean the path to avoid issues with ".." or other problematic elements
workflowDir = filepath.Clean(workflowDir)
// Ensure the path is under .github/workflows
if !strings.HasPrefix(workflowDir, ".github/workflows") {
// If user provided a subdirectory name, prepend .github/workflows/
githubWorkflowsDir = filepath.Join(gitRoot, ".github/workflows", workflowDir)
} else {
githubWorkflowsDir = filepath.Join(gitRoot, workflowDir)
}
Comment on lines +572 to +579
Copy link

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

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

Path traversal vulnerability: filepath.Clean does not prevent path traversal attacks. An attacker could provide --dir ../../../etc which after cleaning becomes ../../../etc, bypassing the .github/workflows prefix check and writing workflows outside the repository. After filepath.Clean, you must validate that the cleaned path does not start with .. or contain .. segments to prevent directory traversal. Add validation like: if strings.Contains(workflowDir, \"..\") { return fmt.Errorf(\"workflow directory cannot contain '..' path elements\") }

Copilot uses AI. Check for mistakes.
} else {
// Use default .github/workflows directory
githubWorkflowsDir = filepath.Join(gitRoot, ".github/workflows")
}

// Ensure the target directory exists
if err := os.MkdirAll(githubWorkflowsDir, 0755); err != nil {
return fmt.Errorf("failed to create .github/workflows directory: %w", err)
return fmt.Errorf("failed to create workflow directory %s: %w", githubWorkflowsDir, err)
}

// Determine the workflowName to use
Expand Down
6 changes: 3 additions & 3 deletions pkg/cli/add_current_repo_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ func TestAddWorkflowsFromCurrentRepository(t *testing.T) {
// Clear cache before each test
ClearCurrentRepoSlugCache()

err := AddWorkflows(tt.workflowSpecs, 1, false, "", "", false, "", false, false)
err := AddWorkflows(tt.workflowSpecs, 1, false, "", "", false, "", false, false, "")

if tt.expectError {
if err == nil {
Expand Down Expand Up @@ -177,7 +177,7 @@ func TestAddWorkflowsFromCurrentRepositoryMultiple(t *testing.T) {
// Clear cache before each test
ClearCurrentRepoSlugCache()

err := AddWorkflows(tt.workflowSpecs, 1, false, "", "", false, "", false, false)
err := AddWorkflows(tt.workflowSpecs, 1, false, "", "", false, "", false, false, "")

if tt.expectError {
if err == nil {
Expand Down Expand Up @@ -218,7 +218,7 @@ func TestAddWorkflowsFromCurrentRepositoryNotInGitRepo(t *testing.T) {

// When not in a git repo, the check should be skipped (can't determine current repo)
// The function should proceed and fail for other reasons (e.g., workflow not found)
err = AddWorkflows([]string{"some-owner/some-repo/workflow"}, 1, false, "", "", false, "", false, false)
err = AddWorkflows([]string{"some-owner/some-repo/workflow"}, 1, false, "", "", false, "", false, false, "")

// Should NOT get the "cannot add workflows from the current repository" error
if err != nil && strings.Contains(err.Error(), "cannot add workflows from the current repository") {
Expand Down
6 changes: 3 additions & 3 deletions pkg/cli/add_gitattributes_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ This is a test workflow.`
os.Remove(".gitattributes")

// Call addWorkflowsNormal with noGitattributes=false
err := addWorkflowsNormal([]*WorkflowSpec{spec}, 1, false, "", "", false, "", false, false)
err := addWorkflowsNormal([]*WorkflowSpec{spec}, 1, false, "", "", false, "", false, false, "")
if err != nil {
// We expect this to fail because we don't have a full workflow setup,
// but gitattributes should still be updated before the error
Expand Down Expand Up @@ -112,7 +112,7 @@ This is a test workflow.`
os.Remove(".gitattributes")

// Call addWorkflowsNormal with noGitattributes=true
err := addWorkflowsNormal([]*WorkflowSpec{spec}, 1, false, "", "", false, "", true, false)
err := addWorkflowsNormal([]*WorkflowSpec{spec}, 1, false, "", "", false, "", true, false, "")
if err != nil {
// We expect this to fail because we don't have a full workflow setup
t.Logf("Expected error during workflow addition: %v", err)
Expand All @@ -134,7 +134,7 @@ This is a test workflow.`
}

// Call addWorkflowsNormal with noGitattributes=true
err := addWorkflowsNormal([]*WorkflowSpec{spec}, 1, false, "", "", false, "", true, false)
err := addWorkflowsNormal([]*WorkflowSpec{spec}, 1, false, "", "", false, "", true, false, "")
if err != nil {
// We expect this to fail because we don't have a full workflow setup
t.Logf("Expected error during workflow addition: %v", err)
Expand Down
6 changes: 3 additions & 3 deletions pkg/cli/add_wildcard_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ on: push

// Test 1: Non-wildcard duplicate should return error
t.Run("non_wildcard_duplicate_returns_error", func(t *testing.T) {
err := addWorkflowWithTracking(spec, 1, false, "", "", false, "", nil, false)
err := addWorkflowWithTracking(spec, 1, false, "", "", false, "", nil, false, "")
if err == nil {
t.Error("Expected error for non-wildcard duplicate, got nil")
}
Expand All @@ -500,15 +500,15 @@ on: push

// Test 2: Wildcard duplicate should return nil (skip with warning)
t.Run("wildcard_duplicate_returns_nil", func(t *testing.T) {
err := addWorkflowWithTracking(spec, 1, false, "", "", false, "", nil, true)
err := addWorkflowWithTracking(spec, 1, false, "", "", false, "", nil, true, "")
if err != nil {
t.Errorf("Expected nil for wildcard duplicate (should skip), got error: %v", err)
}
})

// Test 3: Wildcard duplicate with force flag should succeed
t.Run("wildcard_duplicate_with_force_succeeds", func(t *testing.T) {
err := addWorkflowWithTracking(spec, 1, false, "", "", true, "", nil, true)
err := addWorkflowWithTracking(spec, 1, false, "", "", true, "", nil, true, "")
// This should succeed or return nil
if err != nil && strings.Contains(err.Error(), "already exists") {
t.Errorf("Expected success with force flag, got 'already exists' error: %v", err)
Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/trial_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -726,7 +726,7 @@ func installWorkflowInTrialMode(tempDir string, parsedSpec *WorkflowSpec, logica
}

// Add the workflow from the installed package
if err := AddWorkflows([]string{parsedSpec.String()}, 1, verbose, "", "", true, appendText, false, false); err != nil {
if err := AddWorkflows([]string{parsedSpec.String()}, 1, verbose, "", "", true, appendText, false, false, ""); err != nil {
return fmt.Errorf("failed to add workflow: %w", err)
}
}
Expand Down
Loading