Skip to content

Add rich navigation indexing action#45431

Merged
DanielRosenwasser merged 4 commits intomainfrom
dbaeumer/richNav
Aug 24, 2021
Merged

Add rich navigation indexing action#45431
DanielRosenwasser merged 4 commits intomainfrom
dbaeumer/richNav

Conversation

@dbaeumer
Copy link
Copy Markdown
Member

@dbaeumer dbaeumer commented Aug 12, 2021

This PR adds a GitHub action that indexes the repository for the main and release branches (as well as PRs) and stores the index in RichNav. This allows browsing the repository via vscode.dev with support for rich code navigation.

@typescript-bot typescript-bot added the For Uncommitted Bug PR for untriaged, rejected, closed or missing bug label Aug 12, 2021
@typescript-bot
Copy link
Copy Markdown
Collaborator

This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise.

@dbaeumer dbaeumer mentioned this pull request Aug 12, 2021
Copy link
Copy Markdown
Contributor

@orta orta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I read some of the code around this, the rough gist is that this action will generate lsif results (aka pre-baked LSP results) for the TypeScript repo. These results are then uploaded into a third-party server (I guess it's 1st party though because MS owns it) that are used for a version of vscode which runs in the browser. Unlike codespaces vscode.dev does not come with a SSH-able VM to work inside, instead it makes API requests for those responses to this server for the results of editor actions like 'go to definition'.

Feels like a pretty good abstraction to me

@dbaeumer
Copy link
Copy Markdown
Member Author

dbaeumer commented Aug 13, 2021

.lsifrc.json Outdated
@@ -0,0 +1,6 @@
{
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any way we could have this in a subdirectory to minimize top-level clutter?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, can be in a sub directory. What name would you suggest?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

scripts/lsif ?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively we can move it to the GitHub action source (e.g. .github/workflows)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think moving it to .github/workflows would be ideal, not sure whether others agree.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe .github/workflow-resources in case adding things into the workflows folder has its own issues.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will give it a try

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add it to github/workflow-resources to not tamper with a folder owned by github.

@DanielRosenwasser DanielRosenwasser merged commit b45e129 into main Aug 24, 2021
@DanielRosenwasser DanielRosenwasser deleted the dbaeumer/richNav branch August 24, 2021 20:38
@DanielRosenwasser
Copy link
Copy Markdown
Member

Thank you!

BobobUnicorn pushed a commit to BobobUnicorn/TypeScript that referenced this pull request Oct 24, 2021
* Add rich navigation indexing action

* Remove dbaeumer/richNav from indexed branches

* Move lsifrc file to .github folder

* Remove dbaeumer/richNav
@microsoft microsoft locked as resolved and limited conversation to collaborators Oct 21, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

For Uncommitted Bug PR for untriaged, rejected, closed or missing bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants