GitHub Extension for Visual Studio
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 Visual Studio Marketplace.
Documentation
Visit the documentation for details on how to use the features in the GitHub Extension for Visual Studio.
Build requirements
- Visual Studio 2019
.NET desktop developmentworkload.NET Core cross platform developmentworkloadVisual Studio extension developmentworkload
The built VSIX will work with Visual Studio 2015 or newer
Build
Clone the repository and its submodules.
To be able to use the GitHub API, you'll need to:
- Register a new developer application in your profile
- Create an environment variable
GitHubVS_ClientIDwith yourClient ID - Create an environment variable
GitHubVS_ClientSecretwith yourClient Secret
Execute build.cmd
Visual Studio Build
Build GitHubVS.sln using Visual Studio 2019.
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 - 2019 GitHub, Inc.
Licensed under the MIT License