microsoft / microsoft/vscode-pull-request-github

Permalinks in feature branches on forks should fallback to upstream main for unmodified lines

Open
#7,983 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
TypeScript
Stars
2.6k
Forks
796
Avg merge
1d 4h
Merged PRs (30d)
46

Description

Problem

Referencing prior fix in PR #1816: Permalinks generated from feature branches on forks do not fallback to upstream main, even for lines that are completely unmodified. This harms canonical link-sharing because:

  1. Links to feature branches break when the branch is deleted (common after PR merge)
  2. Recipients may not have access to fork repositories
  3. The same code exists in upstream main but the link doesn't redirect there

Current Behavior

When creating a permalink from a feature branch on a fork:

  • The link points to: fork/repo/blob/feature-branch/file.ext#L123
  • No fallback occurs even if line 123 is identical in upstream main
  • Link becomes invalid after branch deletion

Proposed Enhancement

Extend the permalink generation logic to:

  1. Check if the referenced lines exist unchanged in upstream main
  2. If unchanged, generate permalink to upstream main instead
  3. Fall back to checking other long-lived branches if not in main
  4. Only use feature branch permalink if code is actually modified

main here be substituted for any default branches, or custom list thereof user can config for reference in order of prefernce
ie main/master/release-5/release-4 whereby main is preferred, but if snippet only exists in a release branch, not main, release branch in upstream is still preferred vs fork link, since it affects ability to paste into upstream github and getting content previews.

ie. https://github.com/microsoft/vscode-pull-request-github/blob/45d42a8efb0d9ba5bbf9810dcb78ba865004f67c/build/filters.js#L14

vs

https://github.com/fork/vscode-pull-request-github/blob/45d42a8efb0d9ba5bbf9810dcb78ba865004f67c/build/filters.js#L14

Context Summary

Aspect Current State Proposed State
Fork feature branch (unchanged code) Links to fork/branch Links to upstream/main
Fork feature branch (changed code) Links to fork/branch Links to fork/branch
After branch deletion Link breaks Link still works
Accessibility Fork access required Public upstream access

Benefits

  • More resilient permalink sharing
  • Better canonical link behavior
  • Reduced broken links after PR merges
  • Improved accessibility for external collaborators

This would make permalinks more useful for documentation, issue references, and knowledge sharing.

related: https://github.com/microsoft/vscode-pull-request-github/issues/1781

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking the permalink-related logic and the build/filters.js example mentioned in the issue, then locate the tests covering fork and feature-branch links. Define the precedence for upstream default or configured branches and verify unchanged lines use upstream links while modified lines retain fork links; the issue names no existing test or entry point.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, typescript, vscode
Domain
developer-experience, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.