Skip to content

Test GitHub Pull Request extension #55396

@RMacfarlane

Description

@RMacfarlane

Refs: microsoft/vscode-pull-request-github#1

Complexity: 5

This is to test the GitHub PR extension. This extension is still in a preview state and has some obvious gaps:

  • Better auth flow still in progress
  • No multi-root folder support
  • No support for the GH Review flow
  • No explicit merge support

Please file any issues you run into in the extension's repository.

Setup

  • Download the latest visx from our release page
  • Install the vsix in latest Insider
  • Run Insider from command with flag code-insiders --enable-proposed-api Microsoft.vscode-pull-request-github

Authentication

There are two ways of doing authentication

  • GitHub access token, this is the recommended way right now. The config name is github.accessToken. Please make sure the token you put there has proper access to repo and user
  • If there is no GitHub access token, the extension will try to use the local Git Credential Manager. Whether the authentication will work depends on if your local credentials work.
    There is an known bug when you are using ssh and the passphrase expires, the extension will fail slightly.

Testing

Some things to try/verify:

Pull Request tree view:

  • View pull requests in SCM viewlet when a GitHub repository is opened in VSCode, the predefined categories work as expected.
  • View file changes from the Pull Request tree view and create comments within these.
  • View the description page for a pull request, the timeline events of a pull request are rendered properly.
  • Leave generic issue comments in the description page for a pull request.
  • Context menu for a pull request item, file change item in the tree view
  • If the repository contains many PRs, a load more button appears for the category within the tree and works as expected.

Review mode

  • Checkout to a pull request from Pull Request description page or content menu of Pull Request tree view works, the comments panel and additional "Changes in Pull Request" tree view shows up in the SCM viewlet.
  • Navigate through comments in the Command Panel.
  • View/Create comments in a normal editor.
  • Comments positions are adjusted when you make changes to local content.
  • The "Changes in Pull Request" view lists file changes and all commits in the PR.
  • After modifying/adding/deleting comments for the pull request on GitHub, comments within VSCode are updating to reflect this within a minute.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions