Skip to content

Commit 6ef9ad6

Browse files
authored
Merge pull request #2391 from asb3993/amburns-tfvc-improvements
Adding updates for 0.3 release
2 parents 1d6c307 + 1285438 commit 6ef9ad6

18 files changed

+95
-34
lines changed

mac/media/tfvc-add-new-creds.png

57.4 KB
Loading

mac/media/tfvc-add-new-server.png

51.1 KB
Loading

mac/media/tfvc-choose-server-type.png

-26.5 KB
Loading
21.7 KB
Loading

mac/media/tfvc-local-workspace.png

16.9 KB
Loading

mac/media/tfvc-login.png

-27.6 KB
Loading

mac/media/tfvc-manage-workspaces.png

-76.3 KB
Loading

mac/media/tfvc-setup-empty-sce.png

22.3 KB
Loading
17.3 KB
Loading

mac/media/tfvc-sourcecode-actions.png

18 KB
Loading

mac/media/tfvc-update.png

71.4 KB
Loading

mac/media/tfvc-vsts-login.png

52.4 KB
Loading

mac/media/tfvc-vsts-projects.png

101 KB
Loading

mac/media/tfvc-workspace1.png

57.8 KB
Loading

mac/media/tfvc-workspace2.png

22.7 KB
Loading

mac/media/tfvc-workspace3.png

64.1 KB
Loading

mac/media/tfvc-workspace4.png

16.5 KB
Loading

mac/tf-version-control.md

Lines changed: 95 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -30,81 +30,142 @@ In Visual Studio for Mac, choose **Visual Studio > Extensions...** from the menu
3030

3131
Follow the prompts to install the extension. Once it's installed, restart the IDE.
3232

33+
## Updating the extension
34+
35+
Updates to the TFVC extension are made periodically. To access updates, choose **Visual Studio > Extensions...** from the menu and select the **Updates** tab. Select the extension in the list and press the **Update** button:
36+
37+
![Extension manager showing update](media/tfvc-update.png)
38+
39+
Press **Install** on the next dialog to uninstall the old package and install the new one.
40+
41+
For information on what's new in each release, see the [Release Notes](https://docs.microsoft.com/visualstudio/releasenotes/vs2017-mac-preview-relnotes#team-foundation-version-control-extension--release-notes).
42+
3343
## Using the add-in
3444

35-
Once the extension is installed, select the **Version Control > TFS/VSTS > Connect to Team Foundation Version Control...** menu item. Click **Add** to add a new account:
45+
Once the extension is installed, select the **Version Control > TFS/VSTS > Open from Remote Repository** menu item.
3646

37-
![Add a TFVC Server](media/tfvc-add-remove-server.png)
47+
Choose either Visual Studio Team Services or Team Foundation Server to get started and press **Continue**:
3848

39-
Choose either Visual Studio Team Services or Team Foundation Server to get started:
49+
![Connect with a Server](media/tfvc-choose-server-type.png)
4050

41-
![Connect with a TFVC Server](media/tfvc-choose-server-type.png)
51+
### VSTS Authentication
4252

43-
Enter your credentials and click **Log in**:
53+
When you select a project that is hosted on VSTS, you're prompted to enter your Microsoft account details:
4454

45-
![Log in to a TFVC Server](media/tfvc-login.png)
55+
![Connect with a VSTS Server](media/tfvc-vsts-login.png)
4656

47-
Once you've successfully logged in, select the projects that you want to access and press **OK**:
57+
### TFS Authentication
4858

49-
![Choose projects](media/tfvc-choose-projects.png)
59+
To connect to TFS, enter the server details and your account credentials. Enter a domain to use NTLM authentication, otherwise leave blank to use basic authentication. Select **Add Server**:
5060

51-
Select the **Version Control > TFS/VSTS > Source Control Explorer** menu item to open the source control explorer allowing you to browse the source.
61+
![Sign in to a TFS Server](media/tfvc-login.png)
5262

53-
> [!IMPORTANT]
54-
> **Known issue**: In this preview release, the first time you open source control explorer, you'll have to [create a new workspace](#creating-a-new-workspace).
63+
## Selecting a project
5564

56-
![Source Explorer](media/tfvc-source-explorer.png)
65+
Once you've successfully authenticated, you can see a list of repositories that are associated with the account in the **Open from Source Control** dialog:
5766

58-
From the Source Code Explorer, you can browse your source code on the server and perform the following actions:
67+
![Open from Source Control dialog with projects displayed](media/tfvc-vsts-projects.png)
5968

60-
- Manage Workspaces (Create, edit, or delete).
61-
- Navigate between project structure.
62-
- Map projects.
63-
- Get projects.
64-
- Lock & Unlock files.
65-
- Rename files.
66-
- Delete files.
67-
- Add new file.
68-
- Check out.
69-
- Check in.
70-
- View history changes.
71-
- Compare changes.
69+
This dialog is organized with the following nodes:
70+
71+
- VSTS account or Collection – This displays all accounts connected to the Microsoft account that you logged in with
72+
- Team Projects – Within each VSTS you can have a number of team projects. A team project is where source code, work items, and automated builds are hosted.
73+
74+
At this point, you can search and filter by the name of a project or account.
75+
76+
### Adding a new server
77+
78+
To add a new server to the list, press the **Add Host** button on the **Open from Source Control** dialog:
79+
80+
![Highlighted add button to add new server to the list](media/tfvc-add-new-server.png)
81+
82+
Select the provider from the list, and enter your credentials:
83+
84+
![Dialog showing option for source control provider](media/tfvc-add-new-creds.png)
7285

7386
## Creating a new workspace
7487

75-
In the Source Control Explorer, click on the **Manage Workspaces** button.
88+
To start working with a project, you need to have a _workspace_. If you don't already have a workspace, you can create one from the **Workspace** combobox in the **Open from Source Control** dialog:
89+
90+
![Create new workspace combobox option](media/tfvc-create-new-workspace.png)
91+
92+
Set the name and local path for your new workspace and select **Create Workspace**:
7693

77-
![Manage Workspaces](media/tfvc-manage-workspaces.png)
94+
![Entering a name and local path for the new workspace](media/tfvc-local-workspace.png)
7895

79-
Click the **Add** button to create a new workspace.
96+
## Using the Source Code Explorer
8097

81-
![Create Workspace](media/tfvc-create-workspace.png)
98+
Once you've created a workspace and mapped your project, you can start working with the _Source Code Explorer_.
8299

83-
Provide a name for the workspace and then click **Add Working Folder** to map the project to a local folder on your computer.
100+
To open the Source Code Explorer, select the **Version Control > TFS/VSTS > Source Control Explorer**:
84101

85-
When done, click **OK**, then close the Manage Workspaces dialog. You're now ready to get files though the Source Code Explorer and get started.
102+
![Menu item to open the source code explorer](media/tfvc-source-control-explorer.png)
103+
104+
The Source Code Explorer enables you to navigate through all the mapped projects, their files, and folders. It also allows you to perform all the basic source control actions such as:
105+
106+
- Get the latest version
107+
- Get a specific version
108+
- Check files in and out
109+
- Lock and unlock files
110+
- Add, delete, and rename files
111+
- View history
112+
- Compare changes.
113+
114+
Many of these actions are available through context actions on the project:
115+
116+
![Context menu actions for a project](media/tfvc-sourcecode-actions.png)
117+
118+
## Managing workspaces
119+
120+
If you haven't already create a workspace, as described in the [Creating a workspace](#creating-a-new-workspace) section, you'll notice that the Source Code Explorer is empty:
121+
122+
![empty source code explorer](media/tfvc-setup-empty-sce.png)
123+
124+
To set up your remote project with a local workspace, use the following steps:
125+
126+
1. Select the **Server** from the combobox.
127+
1. Note that there are "no workspaces" and that the Local Path is "Not Mapped". Select the **Not Mapped** link to display the **Create new Workspace** dialog.
128+
1. Provide a name for the workspace and then click **Add Working Folder** to map the project to a local folder on your computer:
129+
130+
![Create a new workspace dialog showing default options](media/tfvc-workspace1.png)
131+
132+
1. Select the "$" folder to map all Team projects on your server to the same workspace, or select an individual project, and click **OK**:
133+
134+
![Browse for folder dialog showing all projects](media/tfvc-workspace2.png)
135+
136+
1. Select the location on your local machine that you wish mp the project(s) to and click **Select Folder**.
137+
1. Confirm the details of the new workspace by pressing **OK**
138+
139+
![Create new workspace dialog with working folder added](media/tfvc-workspace3.png)
140+
141+
Once your workspace is set up, it can be changed or removed by clicking the **Manage Workspaces** button in the Source Code Explorer.
142+
143+
![Manage Workspaces](media/tfvc-workspace4.png)
86144

87145
## Troubleshooting
88146

89147
### Problems using basic authentication
90148

91-
There are a number of different options available to perform authentication with a server:
149+
The following options can be used to authenticate with a server:
92150

93151
- Oauth
94152
- Basic
95153
- Ntlm
96154

97-
To be able to use basic authentication it is necessary to Enable **Alternative authentication credentials** in VSTS, by following the steps below:
155+
To use basic authentication it is necessary to enable **Alternative authentication credentials** in VSTS, by following the steps below:
98156

99157
1. Sign in as the account owner to your VSTS account (https://{youraccount}.visualstudio.com).
100158
2. From your account toolbar, select the gear icon and select **Policy**:
159+
101160
![Policy settings option selected](media/tfvc-auth2.png)
161+
102162
3. Review your application connection settings. Change these settings, based on your security policies:
163+
103164
![Policy settings option selected](media/tfvc-auth.png)
104165

105166
### I do not see anything in TFVC
106167

107-
To set up Team Foundation Version Control (TFVC) on your dev machine, you **must** create a workspace, as described in the [Creating a new workspace](#creating-a-new-workspace) section.
168+
To set up Team Foundation Version Control (TFVC) on your dev machine, you **must** create a workspace, as described in the [Managing workspaces](#managing-workspaces) section.
108169

109170
In Source Control Explorer, press the **Manage Workspaces** Button. Follow the steps to map the team project to a folder on your dev machine.
110171

0 commit comments

Comments
 (0)