https://github.com/chwebdude/dependencychecker

A NuGet DependencyChecker for Azure DevOps and Team Foundation Server.
https://github.com/chwebdude/dependencychecker

build-automation dependency-analysis

Last synced: about 2 months ago
JSON representation

A NuGet DependencyChecker for Azure DevOps and Team Foundation Server.

• Host: GitHub
• URL: https://github.com/chwebdude/dependencychecker
• Owner: chwebdude
• License: lgpl-3.0
• Created: 2017-08-02T11:41:06.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-06-23T11:34:43.000Z (about 2 years ago)
• Last Synced: 2023-06-26T00:18:38.967Z (about 2 years ago)
• Topics: build-automation, dependency-analysis
• Language: C#
• Homepage: https://marketplace.visualstudio.com/items?itemName=chwebdude.dependency-checker
• Size: 495 KB
• Stars: 10
• Watchers: 3
• Forks: 7
• Open Issues: 9
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NuGet Dependency Checker

- [Release Version](https://marketplace.visualstudio.com/items?itemName=chwebdude.dependency-checker)

- [Preview Version](https://marketplace.visualstudio.com/items?itemName=chwebdude.a46650ae-fa0a-458f-8ca1-7ae59c43838d)

[![Build status](https://dev.azure.com/webdude/DependencyChecker/_apis/build/status/DependencyChecker)](https://dev.azure.com/webdude/DependencyChecker/_build/latest?definitionId=22)

Simple Tool for checking NuGet Dependencies and publish a report as build artifact. The results will be added to a new build tab and can be saved as build artifact. *(no dashboard widget yet, but i will work on it!)*.

**Feel free to submit pull requests for new features!**

## Configuration

![Overview](https://raw.githubusercontent.com/chwebdude/DependencyChecker/master/images/overview.jpg)

## Build Result Tab

![Build Result Tab](https://raw.githubusercontent.com/chwebdude/DependencyChecker/master/images/reportTab.png)

## Report

![Report](https://raw.githubusercontent.com/chwebdude/DependencyChecker/master/images/report.jpg)

## How to start

First add the root directory of the project as Searchpath. This is usually `$(Build.SourcesDirectory)`. If you also check the Search Recursive box all packages.config files will be analyzed.

Now you can say if you want to create a badge and if to create a report. The destination or the reportfile is very important. By default it will be created in the `$(Build.ArtifactStagingDirectory)` directory. Another build tasks has to handle this file. Ex. copy it to a webserver. Depending on your infrastructure you can also do this directly by `\\yourserver\yourshare\dependencies.html`. Just do the same with the badge path.

## Options

### Search Path

Path to check for the packages.config files.

### Search Recursive

Search subdirectories for the packages files.

### Combine Projects

This option will combine all found projects and lists all packages in a distincted form. If a package is installed several times, it will be listed seperatly. This option is similar to Visual Studios "Consolidation" function

### Include Prerelease

Include prerelease packages for search?

### Custom NuGet config file

Define your custom NuGet config which has additional sources.

### Create Badge

Create a badge using [DotBadge](https://github.com/rebornix/DotBadge).

### Create Badge per project

If selected, a badge will be created for every single project found. If not selected, the information of all projects will be aggregated and "the worst" will be generated.

### Badge Path

Where to save the badge and its name. (only available if only one badge needs to be generated)

### Badges Directory Path

Path of the directory where the badges should be generated (only available if multiple badges should be generated)

### Style

The style of the badge.

### Create Report

Create a report of the packages.

### Report Path

Location and name where to save report.

## Development

The buld pipeline is automaticly triggered for all commits in this Repo. The pipeline generates a new [preview extension](https://marketplace.visualstudio.com/items?itemName=chwebdude.a46650ae-fa0a-458f-8ca1-7ae59c43838d) which can be used for testing.

Pipeline runs from the `master` branch will be deployed automaticly to the public extension registry. 

Assemblies and task are versioned according to the last published extension version by increasing the version number.

If you are forking this repo are creating a PR, the pipeline will not publish the extension to the marketplace.

## Thanks

Following open source libraries are used for this little project. Thank you for your great work!

* [CommandLineParser](https://github.com/commandlineparser/commandline)

* [DotBadge](https://github.com/rebornix/DotBadge)

* [NuGet](https://github.com/NuGet/Home)

* [Stubble](https://github.com/stubbleorg/stubble)