feat: project create #115

benPearce1 · 2022-10-14T07:06:53Z

[sc-18973]

This PR is currently blocked on PR OctopusDeploy/go-octopusdeploy#152 and the work on branch https://github.com/OctopusDeploy/go-octopusdeploy/tree/feat/git-credentials being merged

basic project create interaction:

basic project create with creating a project group inline:

Config-as-code project, with project stored credentials:

No-prompts:

into bp/project-create

* fix/check-remaining-for-mock-asker * fix: typo Co-authored-by: Shannon Lewis <slewis74@gmail.com> Co-authored-by: Shannon Lewis <slewis74@gmail.com>

shortcut-integration · 2022-10-14T07:06:56Z

This pull request has been linked to Shortcut Story #18973: CLI vNext: project create.

benPearce1 · 2022-10-14T07:12:19Z

pkg/cmd/project/create/create.go

+	FlagName                    = "name"
+	FlagDescription             = "description"
+	FlagLifecycle               = "lifecycle"
+	FlagConfigAsCode            = "cac"


not sure I am happy with name. Suggestions?

I found when doing release create that it's referred to as "Version Controlled" in almost all places in the octopus codebase and web portal and other documentation. E.g. you'll see documentation snippets like "for a version controlled project...", so I used that term there.
So, within the CLI there's precedent to call this "versionControlled".

On the other hand, the "brand name" that keeps showing up on twitter/linkedin/customer forums is always Config As Code, so 🤷 ? tag @jbristowe

go.mod

borland · 2022-10-14T10:22:58Z

pkg/cmd/dependencies.go

+	"github.com/spf13/cobra"
+)
+
+type Dependable interface {


I completely understand we're trying to fit within the patterns and idioms of golang... but Dependable is perhaps too vague. Does this mean it's never going to let us down? 🤣

borland · 2022-10-14T10:27:39Z

pkg/cmd/dependencies.go

+	GenerateAutomationCmd()
+}
+
+type Dependencies struct {


Perhaps Dependencies might be a bit of a vague name here? My immediate thought is "which dependencies does this struct represent? who depends on them and why?"

From a quick look, it appears as though this struct is meant to carry services (client, asker) and options (space, noprompt) that are commonly used across many commands? If so, some possible naming suggestions?

ServicesAndOptions

CommandContext

CliCommandContext

CommandCommonData

StandardCommandProperties

CommonCommandProperties

GeneralCommandProps

... something to think about anyway

tag @slewis74

borland · 2022-10-14T10:29:29Z

pkg/cmd/dependencies.go

@@ -0,0 +1,57 @@
+package cmd


q for @domenicsim1
Given that this isn't a command itself, should it go under the cmd directory structure, or should it go under just pkg or pkg/somethingelse?

maybe, although it is suppose to be the basis of cmds. Not sure yet, happy to leave it for now.

pkg/cmd/project/create/create.go

borland · 2022-10-14T10:56:49Z

pkg/cmd/project/create/create.go

+	FlagName                    = "name"
+	FlagDescription             = "description"
+	FlagLifecycle               = "lifecycle"
+	FlagConfigAsCode            = "cac"


I found when doing release create that it's referred to as "Version Controlled" in almost all places in the octopus codebase and web portal and other documentation. E.g. you'll see documentation snippets like "for a version controlled project...", so I used that term there.
So, within the CLI there's precedent to call this "versionControlled".

On the other hand, the "brand name" that keeps showing up on twitter/linkedin/customer forums is always Config As Code, so 🤷 ? tag @jbristowe

borland · 2022-10-14T10:59:17Z

pkg/cmd/project/create/create.go

+				}, &opts.GitPassword.Value, survey.WithValidator(survey.ComposeValidators(
+					survey.MaxLength(200),
+					survey.MinLength(1),
+					survey.Required,


IIRC both Required and MinLength(1) do the same job, and we probably don't need both of them.

I ran into this when selecting environments for release deployment, which is a multi-select with min-items(1); Required did the same job but produced a better error message so I used that instead

pkg/cmd/project/create/create.go

Tidy up various parts, rename flag

updated descriptions and removed short flags for git

domenicsim1

🏆 👍

domenicsim1 · 2022-10-18T23:04:10Z

pkg/cmd/dependencies.go

@@ -0,0 +1,57 @@
+package cmd


maybe, although it is suppose to be the basis of cmds. Not sure yet, happy to leave it for now.

domenicsim1 · 2022-10-18T23:10:07Z

pkg/cmd/project/create/create_test.go

+		testutil.NewConfirmPrompt("Would you like to use Config as Code?", "", true),
+		testutil.NewSelectPrompt("Select where to store the Git credentials", "", []string{"Library", "Project"}, "Project"),
+		testutil.NewInputPrompt("Git URL", "The URL of the Git repository to store configuration.", "https://github.com/blah.git"),
+		testutil.NewInputPrompt("Git repository base path", "The path in the repository where Config As Code settings are stored. Default value is '.octopus/'.", "./octopus/project"),
+		testutil.NewInputPrompt("Git branch", "The default branch to use. Default value is 'main'.", "main"),
+		testutil.NewInputPrompt("Initial Git commit message", "The commit message used in initializing. Default value is 'Initial commit of deployment process'.", "init message"),
+		testutil.NewInputPrompt("Git username", "The Git username.", "user1"),
+		testutil.NewPasswordPrompt("Git password", "The Git password.", "password"),


🧑‍🍳 💋

borland · 2022-10-19T00:03:49Z

pkg/cmd/project/create/create_opts.go

+
+func getGitBranch(opts *CreateOptions) string {
+	if opts.GitBranch.Value == "" {
+		return "main"


Lots of people have git branches where the default is 'master' so this might cause them problems?
I'm not sure how much effort we want to go to in solving this though.

main is the default in the UI and also the default when you create a new repo in GitHub, which has been the case for a couple of years (https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/).
At Octopus, we also went through a process of swapping the default branch to main where it was easy to do so. Server is still using master, but most other repos are main

For sure, but most companies are not nearly so forward-thinking as Octopus 😄 There's still a ton of 'master' out there. I can't say if this matters or not, but it'd be good to raise the question in a standup, if you haven't already, that's all. Cheers

benPearce1 and others added 14 commits October 7, 2022 13:56

basic working project create

f3e7fca

project create with lifecycle and group prompts

c283bde

project create initial integration tests

9653db3

skip select if there is only one option

88b416b

feat: nested commands (#109)

98d10ca

Merge branch 'bp/project-create' of https://github.com/OctopusDeploy/cli

f0a5a76

into bp/project-create

working project vcs config

5f50b52

cac support with project stored credentials

d55ff9b

chore: code refactor and testing changes

16acf77

prompt ordering

5a94d1f

Merge from 'main'

4d79676

fix/check-remaining-for-mock-asker (#114)

4085d57

* fix/check-remaining-for-mock-asker * fix: typo Co-authored-by: Shannon Lewis <slewis74@gmail.com> Co-authored-by: Shannon Lewis <slewis74@gmail.com>

move common ask name function

b0311f2

tests for CaC questions

15f4428

benPearce1 requested a review from a team October 14, 2022 07:06

benPearce1 marked this pull request as draft October 14, 2022 07:07

benPearce1 commented Oct 14, 2022

View reviewed changes

benPearce1 added 2 commits October 14, 2022 17:20

move funcs closer to where they are being used

86c5baa

use the helper method

c86ad72

jbristowe reviewed Oct 14, 2022

View reviewed changes

go.mod Outdated Show resolved Hide resolved

accident

5d97470

borland requested changes Oct 14, 2022

View reviewed changes

benPearce1 added 7 commits October 17, 2022 17:02

Add support for reference git credentials

b00c777

Tidy up various parts, rename flag

missed automation on git base path

086a0aa

rename cac

cf38f22

fixed up examples in doc

a69591d

update client reference

f79b8f7

update indirect package references

2c0d949

missed flag

57d6f46

updated descriptions and removed short flags for git

benPearce1 added 4 commits October 18, 2022 12:01

fixed up commit structure for no-prompt scenario

487aaa7

use formatting commands rather than concatenation

91a4f0c

fix up tests

3b5aa46

another test fix

ec7cbd3

benPearce1 marked this pull request as ready for review October 18, 2022 02:17

domenicsim1 approved these changes Oct 18, 2022

View reviewed changes

borland reviewed Oct 19, 2022

View reviewed changes

borland approved these changes Oct 19, 2022

View reviewed changes

remove redundant input constraint

2f2b6d2

benPearce1 merged commit 0a2e409 into main Oct 19, 2022

benPearce1 deleted the bp/project-create branch October 19, 2022 00:37

team-integrations-fnm-bot mentioned this pull request Oct 19, 2022

chore(main): release 0.5.0 #113

Merged

This was referenced Jul 28, 2023

chore(main): release 0.0.1 #258

Closed

chore(main): release 1.5.0 #260

Merged

team-integrations-fnm-bot mentioned this pull request Jun 26, 2024

chore(main): release 2.4.0 #359

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: project create #115

feat: project create #115

benPearce1 commented Oct 14, 2022 •

edited

Loading

shortcut-integration bot commented Oct 14, 2022

benPearce1 Oct 14, 2022

borland Oct 14, 2022

borland Oct 14, 2022

borland Oct 14, 2022

borland Oct 14, 2022

borland Oct 14, 2022

domenicsim1 Oct 18, 2022 •

edited

Loading

borland Oct 14, 2022

borland Oct 14, 2022

domenicsim1 left a comment

domenicsim1 Oct 18, 2022 •

edited

Loading

domenicsim1 Oct 18, 2022

borland Oct 19, 2022

benPearce1 Oct 19, 2022

borland Oct 19, 2022 •

edited

Loading

feat: project create #115

feat: project create #115

Conversation

benPearce1 commented Oct 14, 2022 • edited Loading

shortcut-integration bot commented Oct 14, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domenicsim1 Oct 18, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domenicsim1 left a comment

Choose a reason for hiding this comment

domenicsim1 Oct 18, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borland Oct 19, 2022 • edited Loading

Choose a reason for hiding this comment

benPearce1 commented Oct 14, 2022 •

edited

Loading

domenicsim1 Oct 18, 2022 •

edited

Loading

domenicsim1 Oct 18, 2022 •

edited

Loading

borland Oct 19, 2022 •

edited

Loading