GitHub Extension for Visual Studio

Notices

If you are having issues with the installer, please read

If you need to upgrade, downgrade, or uninstall the extension, and are having problems doing so, refer to this issue: github#1394 which details common problems and solutions when using the installer.

The location of the submodules has changed as of 31-01-2017

If you have an existing clone, make sure to run git submodule sync to update your local clone with the new locations for the submodules.

About

The GitHub Extension for Visual Studio provides GitHub integration in Visual Studio 2015 and newer. Most of the extension UI lives in the Team Explorer pane, which is available from the View menu.

Official builds of this extension are available at the official website.

Documentation

Visit the documentation for details on how to use the features in the GitHub Extension for Visual Studio.

Build requirements

• Visual Studio 2017 (15.7.4)+
• Visual Studio SDK
• The built VSIX will work with Visual Studio 2015 or newer

Build

Clone the repository and its submodules in a git GUI client or via the command line:

git clone https://github.com/github/VisualStudio
cd VisualStudio
git submodule init
git submodule deinit script
git submodule update

Open the GitHubVS.sln solution with Visual Studio 2017+. To be able to use the GitHub API, you'll need to:

• Register a new developer application in your profile.
• Open src/GitHub.Api/ApiClientConfiguration_User.cs and fill out the clientId/clientSecret fields for your application. Note this has recently changed location, so you may need to re-do this

Build using Visual Studio 2017 or:

build.cmd

Install in live (non-Experimental) instances of Visual Studio 2015 and 2017:

install.cmd

Note, the script will only install in one instance of Visual Studio 2017 (Enterprise, Professional or Community).

Build Flavors

The following can be executed via cmd.exe.

To build and install a Debug configuration VSIX:

build.cmd Debug
install.cmd Debug

To build and install a Release configuration VSIX:

build.cmd Release
install.cmd Release

Logs

Logs can be viewed at the following location:

%LOCALAPPDATA%\GitHubVisualStudio\extension.log

Troubleshooting

If you have issues building with failures similar to:

"The type or namespace name does not exist..."

or

"Unable to find project... Check that the project reference is valid and that the project file exists."*

Close Visual Studio and run the following command to update submodules and clean your environment.

clean.cmd

More information

• Andreia Gaita's presentation at Codemania 2016 about this extension.

Contributing

Visit the Contributor Guidelines for details on how to contribute as well as the Contributor Covenant Code of Conduct for details on how to participate.

Copyright

Copyright 2015 - 2018 GitHub, Inc.

Licensed under the MIT License