Feature: Parse reference attributes from --ref in workspace add (#20261) by omsadegaonkar · Pull Request #20269 · conan-io/conan

omsadegaonkar · 2026-08-17T01:41:04Z

Changelog: Feature: Parse reference attributes from --ref in workspace add.
Docs: Omit

Removed mutual exclusion check for path and --ref
Added parsing of --ref to extract name, version, user, channel
Uses RecipeReference.loads() for robust parsing
Added clear error message for invalid reference format

fixes #20261

CLAassistant · 2026-08-17T01:41:11Z

All committers have signed the CLA.

memsharded

Some unit test would be necessary for this feature, please try to add some (likely to go in the integration folder, the easier is using the TestClient helper), and ask for guidance if necessary.

Many thanks for your contribution!

memsharded · 2026-08-24T14:34:21Z

    group.add_argument("-nr", "--no-remote", action="store_true",
                       help='Do not use remote, resolve exclusively in the cache')
    args = parser.parse_args(*args)
-    if args.path and args.ref:


Why is this check changed? Seems mostly unrelated to the parsing of --ref

memsharded · 2026-08-24T14:35:28Z

-    ref = conan_api.workspace.add(path,
-                                  args.name, args.version, args.user, args.channel,
-                                  cwd, args.output_folder, remotes=remotes)
+    elif not path:


Same above, I am not sure why this check was changed.

memsharded · 2026-08-24T14:38:49Z

+
    if args.ref:
-        # TODO: Use path here to open in this path
+        if '/' in args.ref or '@' in args.ref:


The --ref should be parsed in any case, it is not intended that --ref can be an incomplete reference with only the name, for that purpose the individual arguments are there.

Probably the RecipeReference validation could be used?
Also, once the RecipeReference is loaded, it doesn't make sense to mix it with individual arguments, it should be either --ref or the individual arguments, but not both. Maybe for that case, an extra check could be added, but not necessary in this PR, this PR can keep focused on the parsing.

memsharded · 2026-08-26T09:25:10Z

Hi @omsadegaonkar

Conan 2.32 release is approaching, if we want this in, it would be necessary to address these things this week. Otherwise, it will have to wait until 2.33 next month. Thanks!

omsadegaonkar · 2026-08-26T12:25:22Z

hey @memsharded Thanks for the review.

The mutual exclusion test was stripped out in an earlier commit, but now it's back in the latest version, also the things u said are taken care of now inside the new commit, like parsing and more.
created a new commit here: 71a7be7

The PR now only deals with parsing of --ref without any other changes.
And I've included integration tests with TestClient as asked. The 3 tests are passing locally.
Thank you.

memsharded

Please merge from develop2 to avoid conflicts

memsharded · 2026-08-26T13:21:13Z

+    # --- PARSING LOGIC
+    name = args.name
+    version = args.version
+    user = args.user
+    channel = args.channel
+
    if args.ref:
-        # TODO: Use path here to open in this path
+        from conan.api.model import RecipeReference
+        try:
+            parsed_ref = RecipeReference.loads(args.ref)
+            name = parsed_ref.name
+            version = parsed_ref.version
+            user = parsed_ref.user
+            channel = parsed_ref.channel


This still allows definition of both arguments, silently ignoring some arguments.

When args.ref is defined, it means args.name/version/user/channel cannot be defined, and defining both should raise an error, that would be better.

memsharded · 2026-08-26T13:21:31Z

+    client.run("export . --user=company")
+
+    client.run("workspace init .")
+    client.run("workspace add --ref mypkg/1.0@company --version=2.0")


This should raise an error, because of defining both arguments.

memsharded · 2026-08-26T13:24:20Z

-    """
-    Add packages to current workspace
-    """


If something is just format/style, better not change it

memsharded · 2026-08-26T13:24:30Z

-    subparser.add_argument("-of", "--output-folder",
-                           help='The root output folder for generated and build files')
+    subparser.add_argument("--ref", help="Open and add this reference (format: name/version@user/channel)")
+    subparser.add_argument("-of", "--output-folder", help='The root output folder for generated and build files')


same, avoid formatting changes

memsharded · 2026-08-26T13:24:45Z

                       help='Do not use remote, resolve exclusively in the cache')
    args = parser.parse_args(*args)
+
+    # keeping the check


remove these lines, nothing changed here

…n-io#20261) - Removed mutual exclusion check for path and --ref - Added parsing of --ref to extract name, version, user, channel - Uses RecipeReference.loads() for robust parsing - Added clear error message for invalid reference format fixes conan-io#20261

omsadegaonkar · 2026-08-26T15:30:39Z

Hello @memsharded , I've cleaned up the branch history and updated the implementation. Only the integration tests and the expected workspace --ref parsing change are included in the most recent commit.
The final difference between upstream and develop2 is just two files, +53/-1, and three out of three tests are passing.
check out this most recent commit.

Thank you! here it is : omsadegaonkar@750a4ef

memsharded · 2026-08-27T08:50:31Z

Merged, will be in 2.32, thanks for the contribution!

omsadegaonkar mentioned this pull request Aug 17, 2026

[feature] Parse reference attributes from reference when using conan workspace add --ref #20261

Closed

1 task

memsharded self-assigned this Aug 24, 2026

memsharded reviewed Aug 24, 2026

View reviewed changes

memsharded reviewed Aug 26, 2026

View reviewed changes

omsadegaonkar force-pushed the feature/20261-parse-ref branch from 5abd67b to 750a4ef Compare August 26, 2026 15:23

memsharded approved these changes Aug 26, 2026

View reviewed changes

memsharded added this to the 2.32.0 milestone Aug 26, 2026

memsharded merged commit 226b40a into conan-io:develop2 Aug 27, 2026
1 check passed

Uh oh!

Conversation

omsadegaonkar commented Aug 17, 2026 • edited by czoido Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Aug 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

memsharded left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

memsharded commented Aug 26, 2026

Uh oh!

omsadegaonkar commented Aug 26, 2026

Uh oh!

memsharded left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

omsadegaonkar commented Aug 26, 2026

Uh oh!

Uh oh!

memsharded commented Aug 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

omsadegaonkar commented Aug 17, 2026 •

edited by czoido

Loading

CLAassistant commented Aug 17, 2026 •

edited

Loading