Skip to content

Support output formats for Project and Project Groups #507

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

Open
mik-ky wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Support output formats for Project and Project Groups #507

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
9a71034
feat: Support output formats for Project view
mik-ky Mar 31, 2025
07cd712
feat: Support output formats for Project group view
mik-ky Mar 31, 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
62 changes: 46 additions & 16 deletions pkg/cmd/project/view/view.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"fmt"
"github.com/OctopusDeploy/cli/pkg/apiclient"
"io"
"strings"

"github.com/MakeNowJust/heredoc/v2"
"github.com/OctopusDeploy/cli/pkg/constants"
Expand Down Expand Up @@ -65,7 +66,7 @@ func NewCmdView(f factory.Factory) *cobra.Command {
viewFlags,
}

return viewRun(opts)
return viewRun(cmd, opts)
},
}

Expand All @@ -75,33 +76,62 @@ func NewCmdView(f factory.Factory) *cobra.Command {
return cmd
}

func viewRun(opts *ViewOptions) error {
type ProjectAsJson struct {
Id string `json:"Id"`
Name string `json:"Name"`
Description string `json:"Description"`
IsVersionControlled bool `json:"IsVersionControlled"`
Branch string `json:"Branch"`
}

func viewRun(cmd *cobra.Command, opts *ViewOptions) error {
project, err := opts.Client.Projects.GetByIdentifier(opts.idOrName)
if err != nil {
return err
}

fmt.Fprintf(opts.out, "%s %s\n", output.Bold(project.Name), output.Dimf("(%s)", project.Slug))

cacBranch := "Not version controlled"
if project.IsVersionControlled {
cacBranch = project.PersistenceSettings.(projects.GitPersistenceSettings).DefaultBranch()
}
fmt.Fprintf(opts.out, "Version control branch: %s\n", output.Cyan(cacBranch))
if project.Description == "" {
fmt.Fprintln(opts.out, output.Dim(constants.NoDescription))
} else {
fmt.Fprintln(opts.out, output.Dim(project.Description))
}

url := opts.Host + project.Links["Web"]

// footer
fmt.Fprintf(opts.out, "View this project in Octopus Deploy: %s\n", output.Blue(url))
return output.PrintResource(project, cmd, output.Mappers[*projects.Project]{
Json: func(p *projects.Project) any {
return ProjectAsJson{
Id: p.GetID(),
Name: p.GetName(),
Description: p.Description,
IsVersionControlled: p.IsVersionControlled,
Branch: cacBranch,
}
},
Table: output.TableDefinition[*projects.Project]{
Header: []string{"NAME", "DESCRIPTION", "ID", "CAC BRANCH"},
Row: func(p *projects.Project) []string {
return []string{output.Bold(p.Name), p.Description, output.Dim(p.GetID()), cacBranch}
},
},
Basic: func(item *projects.Project) string {
var s strings.Builder

s.WriteString(fmt.Sprintf("%s %s\n", output.Bold(project.Name), output.Dimf("(%s)", project.Slug)))
s.WriteString(fmt.Sprintf("Version control branch: %s\n", output.Cyan(cacBranch)))
if project.Description == "" {
s.WriteString(fmt.Sprintln(output.Dim(constants.NoDescription)))
} else {
s.WriteString(fmt.Sprintln(output.Dim(project.Description)))
}

// footer
s.WriteString(fmt.Sprintf("View this project in Octopus Deploy: %s\n", output.Blue(url)))

if opts.flags.Web.Value {
browser.OpenURL(url)
}
if opts.flags.Web.Value {
browser.OpenURL(url)
}

return nil
return s.String()
},
})
}
80 changes: 60 additions & 20 deletions pkg/cmd/projectgroup/view/view.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ package view
import (
"fmt"
"github.com/OctopusDeploy/cli/pkg/apiclient"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/projectgroups"
"io"
"strings"

"github.com/MakeNowJust/heredoc/v2"
"github.com/OctopusDeploy/cli/pkg/constants"
Expand Down Expand Up @@ -63,7 +65,7 @@ func NewCmdView(f factory.Factory) *cobra.Command {
viewFlags,
}

return viewRun(opts)
return viewRun(cmd, opts)
},
}

Expand All @@ -73,37 +75,75 @@ func NewCmdView(f factory.Factory) *cobra.Command {
return cmd
}

func viewRun(opts *ViewOptions) error {
type ProjectLookup struct {
Id string `json:"Id"`
Name string `json:"Name"`
}

type ProjectGroupAsJson struct {
Id string `json:"Id"`
Name string `json:"Name"`
Description string `json:"Description"`
Projects []output.IdAndName `json:"Projects"`
}

func viewRun(cmd *cobra.Command, opts *ViewOptions) error {
projectGroup, err := opts.Client.ProjectGroups.GetByIDOrName(opts.idOrName)
if err != nil {
return err
}

fmt.Fprintf(opts.out, "%s %s\n", output.Bold(projectGroup.GetName()), output.Dimf("(%s)", projectGroup.GetID()))

if projectGroup.Description == "" {
fmt.Fprintln(opts.out, output.Dim(constants.NoDescription))
} else {
fmt.Fprintln(opts.out, output.Dim(projectGroup.Description))
}

projects, err := opts.Client.ProjectGroups.GetProjects(projectGroup)
if err != nil {
return err
}
fmt.Fprintf(opts.out, output.Cyan("\nProjects:\n"))
for _, project := range projects {
fmt.Fprintf(opts.out, "%s (%s)\n", output.Bold(project.GetName()), project.Slug)
}

url := fmt.Sprintf("%s/app#/%s/projects?projectGroupId=%s", opts.Host, projectGroup.SpaceID, projectGroup.GetID())

// footer
fmt.Fprintf(opts.out, "\nView this project group in Octopus Deploy: %s\n", output.Blue(url))
return output.PrintResource(projectGroup, cmd, output.Mappers[*projectgroups.ProjectGroup]{
Json: func(pg *projectgroups.ProjectGroup) any {
projectsLookup := []output.IdAndName{}

if opts.flags.Web.Value {
browser.OpenURL(url)
}
for _, p := range projects {
projectsLookup = append(projectsLookup, output.IdAndName{Id: p.ID, Name: p.Name})
}

return nil
return ProjectGroupAsJson{
Id: pg.GetID(),
Name: pg.GetName(),
Description: pg.Description,
Projects: projectsLookup,
}
},
Table: output.TableDefinition[*projectgroups.ProjectGroup]{
Header: []string{"NAME", "DESCRIPTION", "ID"},
Row: func(pg *projectgroups.ProjectGroup) []string {
return []string{output.Bold(pg.Name), pg.Description, output.Dim(pg.GetID())}
},
},
Basic: func(item *projectgroups.ProjectGroup) string {
var s strings.Builder

s.WriteString(fmt.Sprintf("%s %s\n", output.Bold(projectGroup.GetName()), output.Dimf("(%s)", projectGroup.GetID())))
if projectGroup.Description == "" {
s.WriteString(fmt.Sprintln(output.Dim(constants.NoDescription)))
} else {
s.WriteString(fmt.Sprintln(output.Dim(projectGroup.Description)))
}

s.WriteString(fmt.Sprintf(output.Cyan("\nProjects:\n")))
for _, project := range projects {
s.WriteString(fmt.Sprintf("%s (%s)\n", output.Bold(project.GetName()), project.Slug))
}

// footer
s.WriteString(fmt.Sprintf("\nView this project group in Octopus Deploy: %s\n", output.Blue(url)))

if opts.flags.Web.Value {
browser.OpenURL(url)
}

return s.String()
},
})
}