richcodenavindexer's Introduction

GitHub Action for Rich Code Navigation indexing

This action indexes the repo it runs within and uploads the language service data to the Rich Code Nav service.

Pre-requisite: You must sign-up and be approved for Rich Code Navigation Private Preview prior to installing this GitHub Action.

Example usage

- uses: microsoft/[email protected]
  with:
    repo-token: ${{ github.token }}

Inputs

You may have specific requirements that need additional configurations beyond the default. There are a number of optional inputs that are accepted to support various repository requirements.

Name	Default	Description
`repo-token`		Required input to get access to the repo and should be set to `${{ github.token }}`.
`languages`		List of languages to use when discovering repository symbols, separated by `,`
`environment`	`production`	`development`, `internal`, or `production`
`nugetFeed`		Feed source to use when installing Rich Code Navigation NuGet packages
`nugetVersion`	`latest`	The version of the Rich Code Navigation nuget packages to use. Use `latest` to download the latest package (including pre-releases).
`configFiles`		The config file(s) for the project(s) to be indexed either as glob patterns or specific file paths relative to the root of the repo, separated by ','
`richNavLogOutputDirectory`		A comma-separated list of log files created from the build when RichCodeNav.EnvVarDump is a package reference
`sourceRootDir`		The directory on the machine where the source code is located, if different from the default.
`uploadRichNavArtifacts`	`false`	A boolean indicating whether Rich Nav log files should be uploaded as a build artifact. Not yet supported for GitHub Actions. Instead, please use the output variable `lspLogsPath` to publish Rich Nav artifacts.
`maxParallelIndexingJobs`	2	The number of indexers to be run in parallel.
`typescriptVersion`	0.6.0-next.22	Optional version of TypeScript tools to use. See https://www.npmjs.com/package/lsif. For Typescript to run, you'll need to install node >= 14.5 prior to this task.
`csharpVersion`	4.3.0-3.22307.3	Optional version of Csharp tools to use. For versions see https://dnceng.visualstudio.com/public/_packaging?_a=feed&feed=dotnet-tools
`javaVersion`	0.5.2	Optional version of Java tools to use. For versions see https://github.com/microsoft/lsif-java/releases. For Java to run, you'll need to install the Java JDK >= 11 prior to this task.
`advancedOptionsCpp`		Additional command line arguments to the c++ LSIF tool. E.g. --arch x86 --verbose
`defaultExpiry`	30	The default maximum number of days for an index to be saved (may be overridden by prExpiry and branchRetention settings)
`prExpiry`	7	The maximum number of days for the index of a PR to be saved
`branchRetention`		A comma-separated list of specific branches and maximum number of days to retain; e.g. main, 15, release/production, 30
`msbuildLogOutputDirectory`	source directory	For C#: Specify a different directory if binlogs are not in the source root directory

Outputs

Name	Description
`lspLogsPath`	The path to LSP logs that may be uploaded as an artifact for diagnostics.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

richcodenavindexer's People

Contributors

Stargazers

Watchers

richcodenavindexer's Issues

Planning to upgrade logo on GitHub Marketplace to Microsoft logo by end of May 2021

Team,
We are planning to upgrade the logo for all 13 GitHub Actions projects listed on the GitHub Marketplace to the official Microsoft logo.

We'd like to make this change by the end of May 2021.

Please let us know if you have any objection, otherwise we'll proceed.

Failed to install NuGet package Microsoft.CodeAnalysis.Lsif.Generator version "3.7.0-4.20317.1"

I am currently getting an error with the RichCodeNavIndexer GitHub Action

Failed to install NuGet package Microsoft.CodeAnalysis.Lsif.Generator version "3.7.0-4.20317.1"

Example log output showing missing Nuget Package
https://github.com/warrenbuckley/Compact-Log-Format-Viewer/runs/1697415065?check_suite_focus=true#step:7:140

/cc @jepetty

RichCodeNavIndexer is unable to locate executable file in Npgsql repo

Hello!

A few years back RichCodeNavIndexer was added to Npgsql repo (npgsql/npgsql#3353) and it was working quite well for us.
Unfortunately, about 4 months ago it started failing with an error Error: Unable to locate executable file: C:\Program. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also verify the file has a valid extension for an executable file..
Could you give us an idea if there is something wrong with our .yml config?

cc @roji

Error: Error: Unable to locate executable file: C:\Program.

Error Logs

Run microsoft/[email protected]
##[debug]Running on node.js v16.18.1
##[debug]Reading all inputs...
C:\ProgramData\Chocolatey\bin\nuget.exe sources add -name RichCodeNavFeed -source https://pkgs.dev.azure.com/azure-public/vside/_packaging/vs-buildservices@Local/nuget/v3/index.json -ConfigFile D:\a\_temp\RichCodeNav\nuget.config
Package source with Name: RichCodeNavFeed added successfully.
##[debug]exec tool: nuget
##[debug]arguments:
##[debug]  list
##[debug]  -pre
##[debug]  -source
##[debug]  RichCodeNavFeed
##[debug]  Microsoft.CodeIndex.ClientTool
##[debug]  -ConfigFile
##[debug]  D:\a\_temp\RichCodeNav\nuget.config
##[debug]Installing Microsoft.CodeIndex.ClientTool package version 0.1.2475-alpha...
Error: Error: Unable to locate executable file: C:\Program. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also verify the file has a valid extension for an executable file.
##[debug]Node Action run completed with exit code 1
##[debug]Finishing: Run microsoft/[email protected]

GitHub Action Run

Here is recently failing GitHub Action run
https://github.com/warrenbuckley/Compact-Log-Format-Viewer/actions/runs/3650606456/jobs/6166798507#step:7:38

Recommend Projects

microsoft / richcodenavindexer Goto Github PK