Add support for rich code navigation in GitHub #12855

zadjii-msft · 2022-04-07T21:56:04Z

We discussed this with the GitHub folks. It's pretty cool.

(Rich code nav) brings editor-level navigation capabilities into
GitHub.com for C++ and C# repos

If you want to try it out, you can go here: GitHub web
editor
The link is already on the correct branch. If you haven't used
github.dev before there are two steps to get setup:

In the settings file you'll need to enable Rich Code Nav. If you just
search for "rich", there'll be a checkbox to enable it.
Refresh the page and you should see a stacked papers icon in the task
bar at the bottom. Click on that and select "Latest Index". Then one
more refresh and you should be good to go with navigation in both C#
and C++ files!

miniksa · 2022-04-07T21:59:28Z

build/pipelines/templates/build-console-ci.yml

@@ -11,6 +11,7 @@ jobs:
    BuildConfiguration: ${{ parameters.configuration }}
    BuildPlatform: ${{ parameters.platform }}
    WindowsTerminalBranding: ${{ parameters.branding }}
+    EnableRichCodeNavigation: true


I don't see anything using this variable.

apparently it's magic to turn it on in the code nav tooling itself.

Yes, we use this parameter to tell us to run a specific package called RichCodeNav.EnvVarDump, which is needed for some builds so we can get information about the environment the build is running in.

miniksa · 2022-04-07T22:00:47Z

build/pipelines/templates/codenav-indexer.yml

+jobs:
+- job: CodeNavIndexer
+  displayName: Run Github CodeNav Indexer
+  pool: { vmImage: windows-2019 }


Does it have to run on Windows? Windows is much slower than Linux at starting up here.

I mean it's fine, but just curious.

Unfortunately right now we do have to run on Windows, but we're working on Linux support! We'll send out a mail once we have that ready so you can switch over!

miniksa · 2022-04-07T22:02:38Z

build/pipelines/ci.yml

+  - stage: CodeIndexer
+    displayName: Github CodeNav Indexer
+    dependsOn: [Build_x64]
+    condition: succeeded()
+    jobs:
+      - template: ./templates/codenav-indexer.yml


Oof. Doesn't this mean it's going to run on every push and every rolling build? Won't that end up taking a massive amount of storage space for all those indexes to be saved? I would think we would run it only on main or something.

That is a good question. Lemme bring in the codenav folks to see what they think

Hi! Holly from the codenav team here! We're fine with this running with such high frequency and the storage load, we actually want to test how well we scale to highly active repos. I will say, most folks who onboard do only run our task on builds of main and a few teams have made a separate .yml file just for the build+codenav tasks so that they can have more fine-tuned control of when it runs, but it's up to you what builds you would find benefit from having navigation on.

My bigger concern is that this will build against 3p code on pull requests. We might want to restrict it like we did the ARM64 build 😄

DHowett · 2022-04-13T23:40:17Z

build/pipelines/ci.yml

+  - stage: CodeIndexer
+    displayName: Github CodeNav Indexer
+    dependsOn: [Build_x64]
+    condition: succeeded()
+    jobs:
+      - template: ./templates/codenav-indexer.yml


My bigger concern is that this will build against 3p code on pull requests. We might want to restrict it like we did the ARM64 build 😄

zadjii-msft · 2022-04-14T20:24:08Z

@DHowett I think that's fixed in fe8e173

DHowett

b o o m

ghost · 2022-04-14T20:44:52Z

Hello @DHowett!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

This reverts commit 23ff072.

) This reverts commit 23ff072, as it broke CI.

This is exactly the same as #12855, save for one small difference: ```diff diff --git a/build/pipelines/ci.yml b/build/pipelines/ci.yml index e4e53e9b2..dc9040aeb 100644 --- a/build/pipelines/ci.yml +++ b/build/pipelines/ci.yml @@ -99,7 +99,6 @@ stages: - stage: CodeIndexer displayName: Github CodeNav Indexer dependsOn: [Build_x64] - condition: succeeded() + condition: and(succeeded(), not(eq(variables['Build.Reason'], 'PullRequest'))) jobs: - template: ./templates/codenav-indexer.yml - condition: not(eq(variables['Build.Reason'], 'PullRequest')) ``` Because the first ones failed with an error about a duplicate condition And that hosed the whole CI

ghost · 2022-05-24T17:06:16Z

🎉Windows Terminal Preview v1.14.143 has been released which incorporates this pull request.:tada:

Handy links:

zadjii-msft added 6 commits January 28, 2022 11:13

this is a test

29bcb1a

I literally am incapable of spelling

8ca2ae6

Merge remote-tracking branch 'origin/main' into dev/migrie/ci/gh-codenav

d141ecc

This should add the debugging tool?

ce3619e

this step might be important

4b69991

Merge remote-tracking branch 'origin/main' into dev/migrie/ci/gh-codenav

d23e51d

miniksa reviewed Apr 7, 2022

View reviewed changes

lhecker approved these changes Apr 12, 2022

View reviewed changes

DHowett requested changes Apr 13, 2022

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Apr 13, 2022

disable code index on PRs

fe8e173

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Apr 14, 2022

zadjii-msft assigned DHowett Apr 14, 2022

DHowett approved these changes Apr 14, 2022

View reviewed changes

DHowett added the AutoMerge Marked for automatic merge by the bot when requirements are met label Apr 14, 2022

DHowett merged commit 23ff072 into main Apr 14, 2022

DHowett deleted the dev/migrie/ci/gh-codenav branch April 14, 2022 20:46

DHowett added a commit that referenced this pull request Apr 15, 2022

Revert "Add support for rich code navigation in GitHub (#12855)"

7af5257

This reverts commit 23ff072.

DHowett mentioned this pull request Apr 15, 2022

Revert "Add support for rich code navigation in GitHub" #12909

Merged

DHowett restored the dev/migrie/ci/gh-codenav branch April 15, 2022 01:56

DHowett added a commit that referenced this pull request Apr 15, 2022

Revert "Add support for rich code navigation in GitHub (#12855)" (#12909

30383cc

) This reverts commit 23ff072, as it broke CI.

zadjii-msft mentioned this pull request Apr 15, 2022

Add support for rich code navigation in GitHub, redux #12910

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for rich code navigation in GitHub #12855

Add support for rich code navigation in GitHub #12855

zadjii-msft commented Apr 7, 2022 •

edited by DHowett

Loading

miniksa Apr 7, 2022

zadjii-msft Apr 7, 2022

homitc Apr 8, 2022

miniksa Apr 7, 2022

homitc Apr 8, 2022

miniksa Apr 7, 2022

zadjii-msft Apr 8, 2022

homitc Apr 8, 2022

DHowett Apr 13, 2022

DHowett Apr 13, 2022

zadjii-msft commented Apr 14, 2022

DHowett left a comment

ghost commented Apr 14, 2022

ghost commented May 24, 2022

Add support for rich code navigation in GitHub #12855

Add support for rich code navigation in GitHub #12855

Conversation

zadjii-msft commented Apr 7, 2022 • edited by DHowett Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zadjii-msft commented Apr 14, 2022

DHowett left a comment

Choose a reason for hiding this comment

ghost commented Apr 14, 2022

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

ghost commented May 24, 2022

zadjii-msft commented Apr 7, 2022 •

edited by DHowett

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.