Note: Since this post was published, we have combined the dependency scanning tool with our LiveDoc service.
Dependency scanner
The dependency scanner is a tool for internal QED use.
It is used to create a report of dependencies for internally developed source code.
Dependency scanner authentication
In order to generate a dependency scanner report for a repo one must have an access token that is approved by that repo.
LiveDoc
Starts by creating Cosmos Database if it doesn’t already exist.
Generates a summary of the README.md file to give an overview of the project. Otherwise, if a Markdown tag of #Overview# is present it uses that section.
Generates configuration notes from the README.md file, or uses the #Configuration# section of the same file if that is present.
Generates installation notes from the README.md file, or uses the #Installation# section of the same file if that is present.
LiveDoc also attempts extract developer notes from code comments and the README.md file.
Generates list of project contributors by parsing the root README.md files and pull requests in a project.
LiveDoc Authentication
In order to generate a LiveDoc report for a repo one must have an access token that is approved by that repo.
Developer Portal permissions
LiveDoc and the dependency scanner tool are only available via the Admin menu, which is only available to users who have been granted the Admin role.
The Developer Portal site is secured by tokens generated by Microsoft’s AAD B2C service in Azure. Roles are stored in tokens and the token is accessed by calling await fetch(“/.auth/me”) to determine if the user has the admin role.