Rename --downloadSource to --starter #3425

johnmcollier · 2020-06-25T17:29:37Z

Signed-off-by: John Collier John.J.Collier@ibm.com

What type of PR is this?

Uncomment only one /kind line, and delete the rest.
For example, > /kind bug would simply become: /kind bug

/kind cleanup

What does does this PR do / why we need it:

This PR renames the --downloadSource flag on odo create to --starter, as decided in #3107. Related integration tests and documentation have also been updated.

Which issue(s) this PR fixes:

Fixes #3107

How to test changes / Special notes to the reviewer:
Verify odo create <component> --starter works as expected, and odo create <component> --downloadSource no longer works

Signed-off-by: John Collier <John.J.Collier@ibm.com>

johnmcollier · 2020-06-25T17:29:57Z

/hold til #3291 is merged

maysunfaisal

/lgtm

johnmcollier · 2020-06-26T02:01:12Z

/retest

johnmcollier · 2020-06-27T03:22:38Z

/hold cancel

Ready for approver review
/assign @mik-dass

mik-dass

/approve

openshift-bot · 2020-06-29T11:10:49Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-06-29T12:15:50Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-06-29T12:28:41Z

/retest

Please review the full test history for this PR and help us cut down flakes.

cdrage · 2020-06-29T13:54:54Z

docs/public/deploying-a-devfile-using-odo.adoc

@@ -99,7 +99,7 @@ In this example we will be deploying an https://github.com/odo-devfiles/springbo
 ----
 $ git clone https://github.com/odo-devfiles/springboot-ex
 ----
-Alternatively, you can pass in `--downloadSource` to `odo create` to have odo download a sample project.
+Alternatively, you can pass in `--starter` to `odo create` to have odo download a sample project.


Encountered an issue with documentation this morning when using the previously named --downloadSource functionality. I think that we should change the wording here to something along the lines of:

to have odo download the specified repository under projects

The reason being is that when I used --help it talked about the sample project, which is incorrect, as it's pulling from the projects section of devfile.yaml, so it's a tad confusing.

@cdrage We can change it, but we'll need to change it back as part of #3263

How about download the sample project specified in the devfile?

cdrage · 2020-06-29T14:21:19Z

pkg/odo/cli/component/create.go

@@ -1079,8 +1079,8 @@ func NewCmdCreate(name, fullName string) *cobra.Command {
 	componentCreateCmd.Flags().StringSliceVar(&co.componentEnvVars, "env", []string{}, "Environmental variables for the component. For example --env VariableName=Value")

 	if experimental.IsExperimentalModeEnabled() {
-		componentCreateCmd.Flags().StringVar(&co.devfileMetadata.downloadSource, "downloadSource", "", "Download sample project from devfile.")
-		componentCreateCmd.Flags().Lookup("downloadSource").NoOptDefVal = defaultProjectName //Default value to pass to the flag if one is not specified.
+		componentCreateCmd.Flags().StringVar(&co.devfileMetadata.starter, "starter", "", "Download starter project from devfile.")


Honestly, so weird using this wording. Because if you try to do odo create with just: --starter and --devfile, example:

odo create --starter --devfile https://github.com/odo-devfiles/nodejs-ex/archive/0.0.1.zip

It makes it seem like it's downloading a "sample" project, but it's not, it's downloading the actual project specified in projects under the devfile.yaml file, if that makes sense?

@cdrage There's a separate story open to use the new starterProject field in devfile v2 #3263 with --starter, but starterProject hasn't been finalized in the schema yet.

@cdrage I agree with you this needs to be fixed. But that is a separate issue.
This is just about renaming this flag. It is supposed to download the sample (starter) project from the devfile the original name was creating a lot of confusion. Once the startProject field is added to devfile spec we can fix the rest.

codecov · 2020-06-29T14:55:43Z

Codecov Report

Merging #3425 into master will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3425      +/-   ##
==========================================
- Coverage   46.51%   46.50%   -0.01%     
==========================================
  Files         112      112              
  Lines       11223    11223              
==========================================
- Hits         5220     5219       -1     
+ Misses       5504     5503       -1     
- Partials      499      501       +2

Impacted Files	Coverage Δ
pkg/sync/sync.go	`48.51% <0.00%> (-1.00%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 33a73e3...468e0f9. Read the comment docs.

Signed-off-by: John Collier <John.J.Collier@ibm.com>

openshift-ci-robot · 2020-06-29T16:28:23Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mik-dass

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [mik-dass]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

cdrage

/lgtm

openshift-bot · 2020-06-30T17:17:18Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-06-30T20:45:15Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-06-30T22:03:49Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T00:00:30Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T16:41:17Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T16:54:18Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T17:20:17Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T17:46:33Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T17:59:21Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T18:12:27Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T18:38:27Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T19:04:21Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T19:17:25Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T19:56:19Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T20:09:47Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-01T20:35:18Z

/retest

Please review the full test history for this PR and help us cut down flakes.

Signed-off-by: John Collier <John.J.Collier@ibm.com>

girishramnani · 2020-07-02T23:52:08Z

/retest

girishramnani · 2020-07-02T23:52:37Z

/lgtm

openshift-bot · 2020-07-03T01:32:56Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-03T01:58:55Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-03T09:07:55Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-03T09:33:54Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-03T11:17:50Z

/retest

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2020-07-03T11:43:49Z

/retest

Please review the full test history for this PR and help us cut down flakes.

Rename --downloadSource to --starter

18ef05b

Signed-off-by: John Collier <John.J.Collier@ibm.com>

openshift-ci-robot added the kind/cleanup label Jun 25, 2020

openshift-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. Required by Prow. label Jun 25, 2020

openshift-ci-robot requested review from adisky and maysunfaisal June 25, 2020 17:30

maysunfaisal approved these changes Jun 25, 2020

View reviewed changes

openshift-ci-robot assigned maysunfaisal Jun 25, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 25, 2020

openshift-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. Required by Prow. label Jun 27, 2020

openshift-ci-robot assigned mik-dass Jun 27, 2020

mik-dass approved these changes Jun 29, 2020

View reviewed changes

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. label Jun 29, 2020

cdrage suggested changes Jun 29, 2020

View reviewed changes

openshift-ci-robot assigned cdrage Jun 29, 2020

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 29, 2020

Updates help text to be less ambiguous

d7b26bb

Signed-off-by: John Collier <John.J.Collier@ibm.com>

cdrage approved these changes Jun 30, 2020

View reviewed changes

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 30, 2020

girishramnani added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. label Jul 1, 2020

cdrage mentioned this pull request Jul 2, 2020

Release notes for odo. openshift/openshift-docs#23388

Merged

Merge branch 'master' of github.com:openshift/odo into starterflag

468e0f9

Signed-off-by: John Collier <John.J.Collier@ibm.com>

openshift-ci-robot removed lgtm Indicates that a PR is ready to be merged. Required by Prow. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. labels Jul 2, 2020

openshift-ci-robot assigned girishramnani Jul 2, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jul 2, 2020

openshift-merge-robot merged commit 0ec74bd into redhat-developer:master Jul 3, 2020

johnmcollier mentioned this pull request Jul 7, 2020

Adds documentation on Devfile file reference #3487

Merged

rm3l added the area/refactoring Issues or PRs related to code refactoring label Jun 16, 2023

Rename --downloadSource to --starter #3425

Rename --downloadSource to --starter #3425

Conversation

johnmcollier commented Jun 25, 2020

johnmcollier commented Jun 25, 2020

maysunfaisal left a comment

Choose a reason for hiding this comment

johnmcollier commented Jun 26, 2020

johnmcollier commented Jun 27, 2020

mik-dass left a comment

Choose a reason for hiding this comment

openshift-bot commented Jun 29, 2020

openshift-bot commented Jun 29, 2020

openshift-bot commented Jun 29, 2020

cdrage Jun 29, 2020

Choose a reason for hiding this comment

johnmcollier Jun 29, 2020

Choose a reason for hiding this comment

johnmcollier Jun 29, 2020

Choose a reason for hiding this comment

cdrage Jun 29, 2020

Choose a reason for hiding this comment

johnmcollier Jun 29, 2020

Choose a reason for hiding this comment

kadel Jun 30, 2020

Choose a reason for hiding this comment

codecov bot commented Jun 29, 2020 • edited Loading

Codecov Report

openshift-ci-robot commented Jun 29, 2020

cdrage left a comment

Choose a reason for hiding this comment

openshift-bot commented Jun 30, 2020

openshift-bot commented Jun 30, 2020

openshift-bot commented Jun 30, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

openshift-bot commented Jul 1, 2020

girishramnani commented Jul 2, 2020

girishramnani commented Jul 2, 2020

openshift-bot commented Jul 3, 2020

openshift-bot commented Jul 3, 2020

openshift-bot commented Jul 3, 2020

openshift-bot commented Jul 3, 2020

openshift-bot commented Jul 3, 2020

openshift-bot commented Jul 3, 2020

codecov bot commented Jun 29, 2020 •

edited

Loading