[FEATURE] Setup origin remote on new workspace for compatibility with VSCode pull request plug-in

[dkwon17]

Is your feature request related to a problem? Please describe.

Please note, this issue is only exists for using the try-in-web-ide GitHub action for testing PRs made from forks.

It would be great if new workspaces have the origin remote already set up on new workspaces for out-of-the-box compatibility with vscode pull request plug-in.

By default, the vscode pull-request plugin searches for pull requests in the origin and upstream remote:
Please see the Getting Started section from https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github.

Currently, the workspace created by the factory url provided by the try-in-web-ide GitHub action sets the origin remote to be the repository for the pull request branch, rather than the base repository. Pull requests would be for the base repository, therefore the vscode pull request plug-in does not detect the pull request if the pull request is coming from a forked repository.

Describe the solution you'd like

One way to address this issue could be to have the try-in-web-ide action to configure the remotes via the factory url. To setup the remotes for DevWorkspaces, the spec.template.projects field can be configured.

For example:

    projects:
      - git:
          checkoutFrom:
            remote: fork
            revision: <pull request branch name>
          remotes:
            fork: <user fork repo url>
            origin: <base repo url>
        name: <project name>

This adds two remotes, origin and fork, and checks out the pull request branch from the fork remote.

Currently, it is not possible to override the spec.template.projects section via the factory url. Please see eclipse-che/che#20137.

Describe alternatives you've considered

It is possible manually setup the git remotes within the editor so that the vscode pull request plug-in can detect the pull-request.

Related issue

eclipse-che/che#20137

[dkwon17]

Fixed by #21