Inedo Community Forums Forums
    • Recent
    • Tags
    • Popular
    • Login

    Welcome to the Inedo Forums! Check out the Forums Guide for help getting started.

    If you are experiencing any issues with the forum software, please visit the Contact Form on our website and let us know!

    Implementing IClientCommandProvider.GetClientCommandPreview

    Scheduled Pinned Locked Moved Support
    buildmastersource-controlapi
    4 Posts 1 Posters 7 Views
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • ? This user is from outside of this forum
      Guest
      last edited by

       

      // Summary:
      //     Returns a string containing the command to be passed to the tool.
      //
      // Returns:
      //     String containing the command to be passed to the tool.
      //
      // Remarks:
      //     This will typically be displayed to the user, so passwords should be obscured.
      string GetClientCommandPreview();
      

      I'm not sure how to implement this method in any provider without the arguments (string commandName, string arguments) which are provided to ExecuteClientCommand. Has this method been implemented in any of the existing source control providers yet? Right now it seems like a placeholder in the API for something they plan to implement later.

      Product: BuildMaster
      Version: 4.5.7

      1 Reply Last reply Reply Quote 0
      • ? This user is from outside of this forum
        Guest
        last edited by

        This is implemented, but is only used in the action editor for the Execute Client Command action. Not too many providers actually implement this, since the whole client command provider idea never really took off, but I know offhand that the SourceGear Vault extension does implement it:

        https://github.com/Inedo/bmx-sourcegear/blob/master/VaultProvider.cs#L421

        That extension is a little old, but I think the basic idea is that that method returns the exact arguments that would be passed to the client (with passwords/other sensitive info obscured). Again, it's only used by the editor so you can just return an empty string and it will work fine. We'll try to get the SDK documentation updated soon.

        1 Reply Last reply Reply Quote 0
        • ? This user is from outside of this forum
          Guest
          last edited by

          Even there it doesn't seem to be actually previewing the command that's being run, just giving the other arguments it's passing the the executable along with yours.

          I can understand why IClientCommandProvider didn't take off, it's much easier to use built-in recipes, but the interface really needs to be looked at since the current source control provider implementations don't allow DVCSs to do all of the push/pull/branch/merge things they're known for which really limits available workflows.

          I'm trying to implement it for Mercurial right now and there are quite a few backflips necessary to get it working.

          1 Reply Last reply Reply Quote 0
          • ? This user is from outside of this forum
            Guest
            last edited by

            Sorry, this question somehow got marked as resolved, but it doesn't look like you ever got a response. If you'd like, you can email us at support at inedo.com with details about what you are trying to do, and we can try to give you some more specific help/ideas.

            1 Reply Last reply Reply Quote 0

            Hello! It looks like you're interested in this conversation, but you don't have an account yet.

            Getting fed up of having to scroll through the same posts each visit? When you register for an account, you'll always come back to exactly where you were before, and choose to be notified of new replies (either via email, or push notification). You'll also be able to save bookmarks and upvote posts to show your appreciation to other community members.

            With your input, this post could be even better 💗

            Register Login
            • 1 / 1
            • First post
              Last post
            Inedo Website Home • Support Home • Code of Conduct • Forums Guide • Documentation