Details

    • Type: Task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Docs
    • Labels:
      None
    • Flags:
      Important

      Description

      This issue is to track work done on documenting the new feature 'platform and plugin version management'.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user omefire opened a pull request:

          https://github.com/apache/cordova-cli/pull/214

          CB-9114: Deprecating the --usegit flag

          CB-9114: Deprecating the --usegit flag

          Background:
          http://apache.markmail.org/message/7cf5zovxcgdxgwa2?q=ommenjik+list:org%2Eapache%2Eincubator%2Ecallback-dev+order:date-backward&page=1#query:ommenjik%20list%3Aorg.apache.incubator.callback-dev%20order%3Adate-backward+page:1+mid:c3cep6d3eez5kefe+state:results

          You can merge this pull request into a Git repository by running:

          $ git pull https://github.com/MSOpenTech/cordova-cli CB-9114

          Alternatively you can review and apply these changes as the patch at:

          https://github.com/apache/cordova-cli/pull/214.patch

          To close this pull request, make a commit to your master/trunk branch
          with (at least) the following in the commit message:

          This closes #214


          commit 69f0e152356622300a67153ad8a435f0cc22fdeb
          Author: Omar Mefire <ommenjik@microsoft.com>
          Date: 2015-06-03T20:44:27Z

          CB-9114: Deprecation Warning for --usegit flag


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user omefire opened a pull request: https://github.com/apache/cordova-cli/pull/214 CB-9114 : Deprecating the --usegit flag CB-9114 : Deprecating the --usegit flag Background: http://apache.markmail.org/message/7cf5zovxcgdxgwa2?q=ommenjik+list:org%2Eapache%2Eincubator%2Ecallback-dev+order:date-backward&page=1#query:ommenjik%20list%3Aorg.apache.incubator.callback-dev%20order%3Adate-backward+page:1+mid:c3cep6d3eez5kefe+state:results You can merge this pull request into a Git repository by running: $ git pull https://github.com/MSOpenTech/cordova-cli CB-9114 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/cordova-cli/pull/214.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #214 commit 69f0e152356622300a67153ad8a435f0cc22fdeb Author: Omar Mefire <ommenjik@microsoft.com> Date: 2015-06-03T20:44:27Z CB-9114 : Deprecation Warning for --usegit flag
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user omefire opened a pull request:

          https://github.com/apache/cordova-lib/pull/234

          CB-9114: Log deprecation message when --usegit flag is used

          CB-9114: Log deprecation message when --usegit flag is used
          Moving towards using `cordova platform add git-url#my-branch` instead.

          Background:
          http://apache.markmail.org/message/7cf5zovxcgdxgwa2?q=ommenjik+list:org%2Eapache%2Eincubator%2Ecallback-dev+order:date-backward&page=1#query:ommenjik%20list%3Aorg.apache.incubator.callback-dev%20order%3Adate-backward+page:1+mid:c3cep6d3eez5kefe+state:results

          You can merge this pull request into a Git repository by running:

          $ git pull https://github.com/MSOpenTech/cordova-lib CB-9114

          Alternatively you can review and apply these changes as the patch at:

          https://github.com/apache/cordova-lib/pull/234.patch

          To close this pull request, make a commit to your master/trunk branch
          with (at least) the following in the commit message:

          This closes #234


          commit 08ce7e7d4b4a3f85f0690a72edf17c647e928db0
          Author: Omar Mefire <ommenjik@microsoft.com>
          Date: 2015-06-03T21:01:58Z

          CB-9114: Log deprecation message when --usegit flag is used


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user omefire opened a pull request: https://github.com/apache/cordova-lib/pull/234 CB-9114 : Log deprecation message when --usegit flag is used CB-9114 : Log deprecation message when --usegit flag is used Moving towards using `cordova platform add git-url#my-branch` instead. Background: http://apache.markmail.org/message/7cf5zovxcgdxgwa2?q=ommenjik+list:org%2Eapache%2Eincubator%2Ecallback-dev+order:date-backward&page=1#query:ommenjik%20list%3Aorg.apache.incubator.callback-dev%20order%3Adate-backward+page:1+mid:c3cep6d3eez5kefe+state:results You can merge this pull request into a Git repository by running: $ git pull https://github.com/MSOpenTech/cordova-lib CB-9114 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/cordova-lib/pull/234.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #234 commit 08ce7e7d4b4a3f85f0690a72edf17c647e928db0 Author: Omar Mefire <ommenjik@microsoft.com> Date: 2015-06-03T21:01:58Z CB-9114 : Log deprecation message when --usegit flag is used
          Hide
          githubbot ASF GitHub Bot added a comment -
          Show
          githubbot ASF GitHub Bot added a comment - Github user omefire commented on the pull request: https://github.com/apache/cordova-cli/pull/214#issuecomment-112176978 Related PR : https://github.com/apache/cordova-lib/pull/234
          Show
          githubbot ASF GitHub Bot added a comment - Github user omefire commented on the pull request: https://github.com/apache/cordova-lib/pull/234#issuecomment-112177005 https://github.com/apache/cordova-cli/pull/214
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user TimBarham commented on a diff in the pull request:

          https://github.com/apache/cordova-lib/pull/234#discussion_r32483383

          — Diff: cordova-lib/src/cordova/platform.js —
          @@ -68,6 +68,13 @@ function addHelper(cmd, hooksRunner, projectRoot, targets, opts) {
          }
          }

          + if (opts.usegit) {
          + msg = '\r\nWARNING: The --usegit flag has been deprecated ! \r\n' +
          + 'instead, please use: `cordova platform add git-url#custom-branch`. \r\n' +
          + 'e.g: cordova platform add https://github.com/apache/cordova-android.git#2.4.0 \r\n';
          + events.emit('log', msg);
          — End diff –

          Some nits:

          • Use `\n`, not `\r\n`.
          • Use `\'` rather than backtick (`` ` ``).
          • Use `events.emit('warning'...)`
          • No space before `!` (or even just a period - no need to get too excited :smile.
          • Capital `I` for `Instead`
          Show
          githubbot ASF GitHub Bot added a comment - Github user TimBarham commented on a diff in the pull request: https://github.com/apache/cordova-lib/pull/234#discussion_r32483383 — Diff: cordova-lib/src/cordova/platform.js — @@ -68,6 +68,13 @@ function addHelper(cmd, hooksRunner, projectRoot, targets, opts) { } } + if (opts.usegit) { + msg = '\r\nWARNING: The --usegit flag has been deprecated ! \r\n' + + 'instead, please use: `cordova platform add git-url#custom-branch`. \r\n' + + 'e.g: cordova platform add https://github.com/apache/cordova-android.git#2.4.0 \r\n'; + events.emit('log', msg); — End diff – Some nits: Use `\n`, not `\r\n`. Use `\'` rather than backtick (`` ` ``). Use `events.emit('warning'...)` No space before `!` (or even just a period - no need to get too excited :smile . Capital `I` for `Instead`
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user TimBarham commented on a diff in the pull request:

          https://github.com/apache/cordova-lib/pull/234#discussion_r32484031

          — Diff: cordova-lib/src/cordova/platform.js —
          @@ -68,6 +68,13 @@ function addHelper(cmd, hooksRunner, projectRoot, targets, opts) {
          }
          }

          + if (opts.usegit) {
          + msg = '\r\nWARNING: The --usegit flag has been deprecated ! \r\n' +
          + 'instead, please use: `cordova platform add git-url#custom-branch`. \r\n' +
          + 'e.g: cordova platform add https://github.com/apache/cordova-android.git#2.4.0 \r\n';
          + events.emit('log', msg);
          — End diff –

          Ok, seems backtick is used all over the place, so don't worry about that one :smile:.

          Show
          githubbot ASF GitHub Bot added a comment - Github user TimBarham commented on a diff in the pull request: https://github.com/apache/cordova-lib/pull/234#discussion_r32484031 — Diff: cordova-lib/src/cordova/platform.js — @@ -68,6 +68,13 @@ function addHelper(cmd, hooksRunner, projectRoot, targets, opts) { } } + if (opts.usegit) { + msg = '\r\nWARNING: The --usegit flag has been deprecated ! \r\n' + + 'instead, please use: `cordova platform add git-url#custom-branch`. \r\n' + + 'e.g: cordova platform add https://github.com/apache/cordova-android.git#2.4.0 \r\n'; + events.emit('log', msg); — End diff – Ok, seems backtick is used all over the place, so don't worry about that one :smile:.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user TimBarham commented on a diff in the pull request:

          https://github.com/apache/cordova-cli/pull/214#discussion_r32484109

          — Diff: doc/platform.txt —
          @@ -5,7 +5,10 @@ Synopsis
          Manage project platforms

          add <plat-spec> [...].............. add specified platforms

          Just a minor nit, as for the other change - don't put a space before the `!` (or just replace it with a period). Also, I wonder - should the description come first, then the warning?

          Show
          githubbot ASF GitHub Bot added a comment - Github user TimBarham commented on a diff in the pull request: https://github.com/apache/cordova-cli/pull/214#discussion_r32484109 — Diff: doc/platform.txt — @@ -5,7 +5,10 @@ Synopsis Manage project platforms add <plat-spec> [...] .............. add specified platforms --usegit ...................... retrieve from git instead of npm registry + --usegit ...................... [WARNING: This flag has been deprecated !] + Instead, please use: `cordova platform add git-url#custom-branch`. + e.g: cordova platform add https://github.com/apache/cordova-android.git#2.4.0 + retrieve from git instead of npm registry End diff – Just a minor nit, as for the other change - don't put a space before the `!` (or just replace it with a period). Also, I wonder - should the description come first, then the warning?
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user omefire commented on a diff in the pull request:

          https://github.com/apache/cordova-cli/pull/214#discussion_r33171432

          — Diff: doc/platform.txt —
          @@ -5,7 +5,10 @@ Synopsis
          Manage project platforms

          add <plat-spec> [...].............. add specified platforms

          I think the warning should come first, to immediately catch the user's attention.

          Show
          githubbot ASF GitHub Bot added a comment - Github user omefire commented on a diff in the pull request: https://github.com/apache/cordova-cli/pull/214#discussion_r33171432 — Diff: doc/platform.txt — @@ -5,7 +5,10 @@ Synopsis Manage project platforms add <plat-spec> [...] .............. add specified platforms --usegit ...................... retrieve from git instead of npm registry + --usegit ...................... [WARNING: This flag has been deprecated !] + Instead, please use: `cordova platform add git-url#custom-branch`. + e.g: cordova platform add https://github.com/apache/cordova-android.git#2.4.0 + retrieve from git instead of npm registry End diff – I think the warning should come first, to immediately catch the user's attention.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user omefire commented on the pull request:

          https://github.com/apache/cordova-lib/pull/234#issuecomment-114946578

          Tim, your suggestions have been taken into account, please review.

          Show
          githubbot ASF GitHub Bot added a comment - Github user omefire commented on the pull request: https://github.com/apache/cordova-lib/pull/234#issuecomment-114946578 Tim, your suggestions have been taken into account, please review.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user stevengill commented on the pull request:

          https://github.com/apache/cordova-lib/pull/234#issuecomment-115420444

          Looks good. I'm merging it in.

          Show
          githubbot ASF GitHub Bot added a comment - Github user stevengill commented on the pull request: https://github.com/apache/cordova-lib/pull/234#issuecomment-115420444 Looks good. I'm merging it in.
          Hide
          jira-bot ASF subversion and git services added a comment -

          Commit acee87c8d2a782af8435408be4a1b9437c4ea812 in cordova-lib's branch refs/heads/master from Omar Mefire
          [ https://git-wip-us.apache.org/repos/asf?p=cordova-lib.git;h=acee87c ]

          CB-9114: Log deprecation message when --usegit flag is used. This closes #234

          Show
          jira-bot ASF subversion and git services added a comment - Commit acee87c8d2a782af8435408be4a1b9437c4ea812 in cordova-lib's branch refs/heads/master from Omar Mefire [ https://git-wip-us.apache.org/repos/asf?p=cordova-lib.git;h=acee87c ] CB-9114 : Log deprecation message when --usegit flag is used. This closes #234
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

          https://github.com/apache/cordova-lib/pull/234

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/cordova-lib/pull/234
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user omefire commented on the pull request:

          https://github.com/apache/cordova-lib/pull/234#issuecomment-115461201

          @stevengill, Thanks! could you also merge this related PR ? : https://github.com/apache/cordova-cli/pull/214

          Show
          githubbot ASF GitHub Bot added a comment - Github user omefire commented on the pull request: https://github.com/apache/cordova-lib/pull/234#issuecomment-115461201 @stevengill, Thanks! could you also merge this related PR ? : https://github.com/apache/cordova-cli/pull/214
          Hide
          jira-bot ASF subversion and git services added a comment -

          Commit dccfb3d166945d41f20a6a8433ec84ca0a893c15 in cordova-lib's branch refs/heads/master from Steve Gill
          [ https://git-wip-us.apache.org/repos/asf?p=cordova-lib.git;h=dccfb3d ]

          CB-9114 fixed mistake with deprecation message for --usegit

          Show
          jira-bot ASF subversion and git services added a comment - Commit dccfb3d166945d41f20a6a8433ec84ca0a893c15 in cordova-lib's branch refs/heads/master from Steve Gill [ https://git-wip-us.apache.org/repos/asf?p=cordova-lib.git;h=dccfb3d ] CB-9114 fixed mistake with deprecation message for --usegit
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user stevengill commented on the pull request:

          https://github.com/apache/cordova-lib/pull/234#issuecomment-115464362

          I ended up making a small fix with this btw. events.emit('warn', msg) instead of 'warning'. warning was never displaying

          Show
          githubbot ASF GitHub Bot added a comment - Github user stevengill commented on the pull request: https://github.com/apache/cordova-lib/pull/234#issuecomment-115464362 I ended up making a small fix with this btw. events.emit('warn', msg) instead of 'warning'. warning was never displaying
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user omefire commented on the pull request:

          https://github.com/apache/cordova-lib/pull/234#issuecomment-115732883

          @stevengill , Thanks for the fix !

          Show
          githubbot ASF GitHub Bot added a comment - Github user omefire commented on the pull request: https://github.com/apache/cordova-lib/pull/234#issuecomment-115732883 @stevengill , Thanks for the fix !
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user omefire commented on the pull request:

          https://github.com/apache/cordova-cli/pull/214#issuecomment-116874574

          @nikhilkh

          Show
          githubbot ASF GitHub Bot added a comment - Github user omefire commented on the pull request: https://github.com/apache/cordova-cli/pull/214#issuecomment-116874574 @nikhilkh
          Hide
          jira-bot ASF subversion and git services added a comment -

          Commit d8680d4f54e3aa8b0bcf17591d045ed43006da87 in cordova-cli's branch refs/heads/master from Omar Mefire
          [ https://git-wip-us.apache.org/repos/asf?p=cordova-cli.git;h=d8680d4 ]

          CB-9114: Deprecation Warning for --usegit flag. This closes #214

          Show
          jira-bot ASF subversion and git services added a comment - Commit d8680d4f54e3aa8b0bcf17591d045ed43006da87 in cordova-cli's branch refs/heads/master from Omar Mefire [ https://git-wip-us.apache.org/repos/asf?p=cordova-cli.git;h=d8680d4 ] CB-9114 : Deprecation Warning for --usegit flag. This closes #214
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

          https://github.com/apache/cordova-cli/pull/214

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/cordova-cli/pull/214

            People

            • Assignee:
              omefire Omar Mefire
              Reporter:
              omefire Omar Mefire
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development