feat(controlplane): add workflow description (#541)

Signed-off-by: Miguel Martinez Trivino <[email protected]>

Author: migmartri

app/cli/cmd/workflow_create.go

@@ -24,7 +24,7 @@ import (
 )
 
 func newWorkflowCreateCmd() *cobra.Command {
-	var workflowName, project, team, contract string
+	var workflowName, description, project, team, contract string
 	var skipRACreate bool
 
 	cmd := &cobra.Command{
@@ -57,7 +57,7 @@ func newWorkflowCreateCmd() *cobra.Command {
 			}
 
 			opts := &action.NewWorkflowCreateOpts{
-				Name: workflowName, Team: team, Project: project, ContractID: contract,
+				Name: workflowName, Team: team, Project: project, ContractID: contract, Description: description,
 			}
 
 			workflow, err := action.NewWorkflowCreate(actionOpts).Run(opts)
@@ -105,6 +105,7 @@ func newWorkflowCreateCmd() *cobra.Command {
 	cmd.Flags().StringVar(&workflowName, "name", "", "workflow name")
 	err := cmd.MarkFlagRequired("name")
 	cobra.CheckErr(err)
+	cmd.Flags().StringVar(&description, "description", "", "workflow description")
 
 	cmd.Flags().StringVar(&project, "project", "", "project name")
 	err = cmd.MarkFlagRequired("project")

app/cli/cmd/workflow_list.go

@@ -51,7 +51,7 @@ func WorkflowListTableOutput(workflows []*action.WorkflowItem) error {
 	}
 
 	headerRow := table.Row{"ID", "Name", "Project", "Created At", "Runner", "Last Run status"}
-	headerRowFull := table.Row{"ID", "Name", "Project", "Team", "Created At", "Runner", "Last Run status", "Public", "Contract ID"}
+	headerRowFull := table.Row{"ID", "Name", "Description", "Project", "Team", "Created At", "Runner", "Last Run status", "Public", "Contract ID"}
 
 	t := newTableWriter()
 	if full {
@@ -75,7 +75,7 @@ func WorkflowListTableOutput(workflows []*action.WorkflowItem) error {
 			}
 		} else {
 			row = table.Row{
-				p.ID, p.Name, p.Project, p.Team,
+				p.ID, p.Name, p.Description, p.Project, p.Team,
 				p.CreatedAt.Format(time.RFC822), lastRunRunner, lastRunState,
 				p.Public, p.ContractID,
 			}

app/cli/cmd/workflow_update.go

@@ -23,7 +23,7 @@ import (
 )
 
 func newWorkflowUpdateCmd() *cobra.Command {
-	var workflowID, name, project, team string
+	var workflowID, name, description, project, team string
 	var public bool
 
 	cmd := &cobra.Command{
@@ -44,6 +44,10 @@ func newWorkflowUpdateCmd() *cobra.Command {
 				opts.Public = &public
 			}
 
+			if cmd.Flags().Changed("description") {
+				opts.Description = &description
+			}
+
 			res, err := action.NewWorkflowUpdate(actionOpts).Run(context.Background(), workflowID, opts)
 			if err != nil {
 				return err
@@ -59,6 +63,7 @@ func newWorkflowUpdateCmd() *cobra.Command {
 	cobra.CheckErr(err)
 
 	cmd.Flags().StringVar(&name, "name", "", "workflow name")
+	cmd.Flags().StringVar(&description, "description", "", "workflow description")
 	cmd.Flags().StringVar(&team, "team", "", "team name")
 	cmd.Flags().StringVar(&project, "project", "", "project name")
 	cmd.Flags().BoolVar(&public, "public", false, "is the workflow public")

app/cli/internal/action/workflow_create.go

@@ -30,13 +30,14 @@ func NewWorkflowCreate(cfg *ActionsOpts) *WorkflowCreate {
 }
 
 type NewWorkflowCreateOpts struct {
-	Name, Project, Team, ContractID string
+	Name, Description, Project, Team, ContractID string
 }
 
 func (action *WorkflowCreate) Run(opts *NewWorkflowCreateOpts) (*WorkflowItem, error) {
 	client := pb.NewWorkflowServiceClient(action.cfg.CPConnection)
 	resp, err := client.Create(context.Background(), &pb.WorkflowServiceCreateRequest{
 		Name: opts.Name, Project: opts.Project, Team: opts.Team, SchemaId: opts.ContractID,
+		Description: opts.Description,
 	})
 	if err != nil {
 		return nil, err

app/cli/internal/action/workflow_list.go

@@ -28,14 +28,15 @@ type WorkflowList struct {
 }
 
 type WorkflowItem struct {
-	Name       string           `json:"name"`
-	ID         string           `json:"id"`
-	Team       string           `json:"team"`
-	Project    string           `json:"project,omitempty"`
-	CreatedAt  *time.Time       `json:"createdAt"`
-	RunsCount  int32            `json:"runsCount"`
-	ContractID string           `json:"contractID,omitempty"`
-	LastRun    *WorkflowRunItem `json:"lastRun,omitempty"`
+	Name        string           `json:"name"`
+	Description string           `json:"description,omitempty"`
+	ID          string           `json:"id"`
+	Team        string           `json:"team"`
+	Project     string           `json:"project,omitempty"`
+	CreatedAt   *time.Time       `json:"createdAt"`
+	RunsCount   int32            `json:"runsCount"`
+	ContractID  string           `json:"contractID,omitempty"`
+	LastRun     *WorkflowRunItem `json:"lastRun,omitempty"`
 	// A public workflow means that any user can
 	// - access to all its workflow runs
 	// - their attestation and materials
@@ -75,9 +76,10 @@ func pbWorkflowItemToAction(wf *pb.WorkflowItem) *WorkflowItem {
 	res := &WorkflowItem{
 		Name: wf.Name, ID: wf.Id, CreatedAt: toTimePtr(wf.CreatedAt.AsTime()),
 		Project: wf.Project, Team: wf.Team, RunsCount: wf.RunsCount,
-		ContractID: wf.ContractId,
-		LastRun:    pbWorkflowRunItemToAction(wf.LastRun),
-		Public:     wf.Public,
+		ContractID:  wf.ContractId,
+		LastRun:     pbWorkflowRunItemToAction(wf.LastRun),
+		Public:      wf.Public,
+		Description: wf.Description,
 	}
 
 	return res

app/cli/internal/action/workflow_update.go

@@ -30,15 +30,16 @@ func NewWorkflowUpdate(cfg *ActionsOpts) *WorkflowUpdate {
 }
 
 type NewWorkflowUpdateOpts struct {
-	Name, Project, Team *string
-	Public              *bool
+	Name, Description, Project, Team *string
+	Public                           *bool
 }
 
 func (action *WorkflowUpdate) Run(ctx context.Context, id string, opts *NewWorkflowUpdateOpts) (*WorkflowItem, error) {
 	client := pb.NewWorkflowServiceClient(action.cfg.CPConnection)
 	resp, err := client.Update(ctx, &pb.WorkflowServiceUpdateRequest{
 		Id:   id,
-		Name: opts.Name, Project: opts.Project, Team: opts.Team,
+		Name: opts.Name, Description: opts.Description,
+		Project: opts.Project, Team: opts.Team,
 		Public: opts.Public,
 	})