Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEA-3239: Updated scip Protobuf #114

Merged
merged 7 commits into from
Jan 31, 2024
Merged

Conversation

matthewnitschke-wk
Copy link
Contributor

@matthewnitschke-wk matthewnitschke-wk commented Jan 28, 2024

FEA-3239

Issue Status

The protobuf spec for scip has changed a good amount since the scip-dart indexer was originally written, this pr bumps, and regenerates protobuf assets from 0.2.3 to 0.3.3

The main major code difference being the introduction of signatureDocumentation, an alternative to just re-using the documentation field on SymbolInformation to provide the display string of the symbol in question. One nice this about this change, is the reduction in snapshot bloat that the snapshot tests have (Closes #87)

One other addition is the concept of PositionEncoding, this should also be populated, but I'm currently unsure what value it should be for the dart language in particular. This will be set as a followup in #115

QA

  • Build and push some scip-dart index.scip files to a sourcegraph instance, and verify that symbols work as expected. Specifically look out for signatureDocumentation, verifying that signatures are populated in the sourcegraph popover

@aviary2-wf
Copy link

Security Insights

No security relevant content was detected by automated scans.

Action Items

  • Review PR for security impact; comment "security review required" if needed or unsure
  • Verify aviary.yaml coverage of security relevant code

Questions or Comments? Reach out on Slack: #support-infosec.

@matthewnitschke-wk matthewnitschke-wk changed the title updated scip protobuf Updated scip Protobuf Jan 28, 2024
@bender-wk bender-wk changed the title Updated scip Protobuf FEA-3239: Updated scip Protobuf Jan 28, 2024
@matthewnitschke-wk matthewnitschke-wk marked this pull request as ready for review January 28, 2024 22:28
@matthewnitschke-wk
Copy link
Contributor Author

QA +1

indexed and uploaded scip-dart to sourcegraph, verified that uploaded analysis is as you would expect

@matthewnitschke-wk
Copy link
Contributor Author

🚀 @Workiva/release-management-p 🚢

Copy link

@rmconsole-wf rmconsole-wf left a comment

Choose a reason for hiding this comment

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

+1 from RM

@rmconsole3-wf rmconsole3-wf merged commit f6f7ca7 into master Jan 31, 2024
11 of 12 checks passed
@rmconsole3-wf rmconsole3-wf deleted the updated_scip_protobuf branch January 31, 2024 02:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants