From b1507a40fb8d9d1b3181ad7b874a6d98711aa20c Mon Sep 17 00:00:00 2001 From: Teo Voinea <58236992+tevoinea@users.noreply.github.com> Date: Fri, 19 Nov 2021 10:19:04 -0800 Subject: [PATCH] Update links (#2) --- .../new_detector_template.md | 4 ++-- Directory.Build.props | 8 +++---- README.md | 14 +++++------ docs/linux-scanner.md | 2 +- docs/renewing-secrets.md | 12 ++++------ .../Resources/project_assets_2_2.json | 24 +++++++++---------- .../project_assets_2_2_additional.json | 16 ++++++------- 7 files changed, 38 insertions(+), 42 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/new_detector_template.md b/.github/PULL_REQUEST_TEMPLATE/new_detector_template.md index b5e10903f..e20bdbb76 100644 --- a/.github/PULL_REQUEST_TEMPLATE/new_detector_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/new_detector_template.md @@ -4,7 +4,7 @@ #### New Detector Checklist -- [ ] I have gone through the docs for creating a new detector [here](https://github.com/microsoft/componentdetection-bcde/blob/main/docs/creating-a-new-detector.md) +- [ ] I have gone through the docs for creating a new detector [here](https://github.com/microsoft/component-detection/blob/main/docs/creating-a-new-detector.md) - [ ] My new detector implements `IDefaultOffComponentDetector` - [ ] I have created a PR to the [verification repo](https://github.com/microsoft/componentdetection-verification) with components that my new detector can find -- [ ] (If necessary) I have updated the [Feature Overview](https://github.com/microsoft/componentdetection-bcde/blob/main/README.md#feature-overview) table in the README +- [ ] (If necessary) I have updated the [Feature Overview](https://github.com/microsoft/component-detection/blob/main/README.md#feature-overview) table in the README diff --git a/Directory.Build.props b/Directory.Build.props index 841882bd5..a2c1a16b2 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -13,10 +13,10 @@ Copyright © Microsoft Corporation. All rights reserved. true MIT - https://github.com/microsoft/componentdetection-bcde - https://github.com/microsoft/componentdetection-bcde.git + https://github.com/microsoft/component-detection + https://github.com/microsoft/component-detection.git git - https://github.com/microsoft/componentdetection-bcde/releases + https://github.com/microsoft/component-detection/releases @@ -37,4 +37,4 @@ - \ No newline at end of file + diff --git a/README.md b/README.md index 3c002da09..4a62fae4f 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # Component Detection -![Component Detection CI](https://github.com/microsoft/componentdetection-bcde/workflows/Component%20Detection%20CI/badge.svg) +![Component Detection CI](https://github.com/microsoft/component-detection/workflows/Component%20Detection%20CI/badge.svg) **For bugs, issues, and support please create an issue.** # Introduction -ComponentDetection (BCDE) is a package scanning tool intended to be used at build time. BCDE produces a graph-based output of all detected components and supports a variety of open source package ecosystems. +ComponentDetection is a package scanning tool intended to be used at build time. CD produces a graph-based output of all detected components and supports a variety of open source package ecosystems. # Table of Contents * [Feature Overview](#Feature-Overview) * [My favorite language/ecosystem isn't supported!](#My-favorite-language/ecosystem-isn't-supported!) -* [Building and running BCDE](#Building-and-running-BCDE) +* [Building and running Component Detection](#Building-and-running-Component-Detection) * [Running in Visual Studio (2019+)](#Running-in-Visual-Studio-(2019+)) * [Running from command line](#Running-from-command-line) * [After building](#After-building) @@ -38,10 +38,10 @@ For a complete feature overview refer to [feature-overview.md](docs/feature-over # My favorite language/ecosystem isn't supported! -BCDE is built with extensibility in mind! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) to get started where you can find additional docs on adding your own detector. +Component Detection is built with extensibility in mind! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) to get started where you can find additional docs on adding your own detector. -# Building and running BCDE +# Building and running Component Detection DotNet Core SDK 6.0.0-rc2 is currently in use, you can install it from https://dotnet.microsoft.com/download/dotnet/6.0 We also use node and npm, you can install them from https://nodejs.org/en/download/ @@ -59,14 +59,14 @@ From the base folder: ## Using Codespaces -If you have access to [GitHub Codespaces](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/about-codespaces), select the `Code` button from the [repository homepage](https://github.com/microsoft/componentdetection-bcde) then select `Open with Codespaces`. That's it! You have a full developer environment that supports debugging, testing, auto complete, jump to definition, everything you would expect. +If you have access to [GitHub Codespaces](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/about-codespaces), select the `Code` button from the [repository homepage](https://github.com/microsoft/component-detection) then select `Open with Codespaces`. That's it! You have a full developer environment that supports debugging, testing, auto complete, jump to definition, everything you would expect. ## Using VS Code DevContainer This is similar to Codespaces: 1. Make sure you meet [the requirements](https://code.visualstudio.com/docs/remote/containers#_getting-started) and follow the installation steps for DevContainers in VS Code -1. `git clone https://github.com/microsoft/componentdetection-bcde` +1. `git clone https://github.com/microsoft/component-detection` 1. Open this repo in VS Code 1. A notification should popup to reopen the workspace in the container. If it doesn't, open the [`Command Palette`](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_command-palette) and type `Remote-Containers: Reopen in Container`. diff --git a/docs/linux-scanner.md b/docs/linux-scanner.md index f3586b799..040ec20c9 100644 --- a/docs/linux-scanner.md +++ b/docs/linux-scanner.md @@ -13,7 +13,7 @@ There are 2 options for working on the Linux scanner: **NOTE**: Docker + WSL2 is not a shortcut for this :( The bind mount is still not support even if it's created in WSL2. (See the Windows way to udnerstand why it's necessary) 1. [Using Hyper-V Quick Create](https://blogs.windows.com/windowsdeveloper/2018/09/17/run-ubuntu-virtual-machines-made-even-easier-with-hyper-v-quick-create/), create a Ubuntu virtual machine. Make sure you give it at least 30gb of storage, docker and the images use a lot of space. -2. Clone BCDE in your VM +2. Clone Component Detection in your VM 3. Install docker 4. Start developing! diff --git a/docs/renewing-secrets.md b/docs/renewing-secrets.md index d14793f83..eb90e1c78 100644 --- a/docs/renewing-secrets.md +++ b/docs/renewing-secrets.md @@ -2,24 +2,20 @@ Almost all of our [workflows](../.github/workflows) require secrets and those secrets can be invalidated, deleted or expired so we need to know how to renew them. -The secrets in use today in the BCDE repo can be found [here](https://github.com/microsoft/componentdetection-bcde/settings/secrets): +The secrets in use today in the Component Detection repo can be found [here](https://github.com/microsoft/component-detection/settings/secrets): * GH_PRIVATE_REPO_PAT -## Before Starting - -Verify your account has sufficient permissions. You can do this by building BCDE locally. This will verify you have access to read the packages being created and read the private BCDE repo. - ## Renewing GH_PRIVATE_REPO_PAT 1. Click this link: https://github.com/settings/tokens/new -1. (Optional) Name the token BCDE_GH_PRIVATE_REPO_PAT. This will make things easier to track in the future +1. (Optional) Name the token COMPONENT_DETECTION_GH_PRIVATE_REPO_PAT. This will make things easier to track in the future 1. Check the following permissions: * Full `repo` scope * `read:packages` scope 1. Click **Generate token** 1. Copy and paste that token into notepad once you see it because it will disappear as soon as you leave the page -1. Enable SSO for both GitHub and Microsoft organizations for the token -1. In the [BCDE secrets page](https://github.com/microsoft/componentdetection-bcde/settings/secrets) click update on **GH_PRIVATE_REPO_PAT** +1. Enable SSO for Microsoft organizations for the token +1. In the [Component Detection secrets page](https://github.com/microsoft/component-detection/settings/secrets) click update on **GH_PRIVATE_REPO_PAT** 1. Paste in your new token 1. Click **Update Secret** diff --git a/test/Microsoft.ComponentDetection.Detectors.Tests/Resources/project_assets_2_2.json b/test/Microsoft.ComponentDetection.Detectors.Tests/Resources/project_assets_2_2.json index 52126602d..bf0c11a4c 100644 --- a/test/Microsoft.ComponentDetection.Detectors.Tests/Resources/project_assets_2_2.json +++ b/test/Microsoft.ComponentDetection.Detectors.Tests/Resources/project_assets_2_2.json @@ -9240,11 +9240,11 @@ "project": { "version": "1.0.0", "restore": { - "projectUniqueName": "D:\\Source\\componentdetection-bcde\\src\\Loader\\MS.VS.Services.Governance.ComponentDetection.Loader.csproj", + "projectUniqueName": "D:\\Source\\component-detection\\src\\Loader\\MS.VS.Services.Governance.ComponentDetection.Loader.csproj", "projectName": "Microsoft.VisualStudio.Services.Governance.ComponentDetection.Loader", - "projectPath": "D:\\Source\\componentdetection-bcde\\src\\Loader\\MS.VS.Services.Governance.ComponentDetection.Loader.csproj", + "projectPath": "D:\\Source\\component-detection\\src\\Loader\\MS.VS.Services.Governance.ComponentDetection.Loader.csproj", "packagesPath": "C:\\Users\\brphelps\\.nuget\\packages\\", - "outputPath": "D:\\Source\\componentdetection-bcde\\src\\Loader\\obj\\", + "outputPath": "D:\\Source\\component-detection\\src\\Loader\\obj\\", "projectStyle": "PackageReference", "fallbackFolders": [ "C:\\Program Files\\dotnet\\sdk\\NuGetFallbackFolder" @@ -9263,17 +9263,17 @@ "frameworks": { "netcoreapp2.2": { "projectReferences": { - "D:\\Source\\componentdetection-bcde\\src\\Common\\MS.VS.Services.Governance.ComponentDetection.Common.csproj": { - "projectPath": "D:\\Source\\componentdetection-bcde\\src\\Common\\MS.VS.Services.Governance.ComponentDetection.Common.csproj" + "D:\\Source\\component-detection\\src\\Common\\MS.VS.Services.Governance.ComponentDetection.Common.csproj": { + "projectPath": "D:\\Source\\component-detection\\src\\Common\\MS.VS.Services.Governance.ComponentDetection.Common.csproj" }, - "D:\\Source\\componentdetection-bcde\\src\\Contracts\\MS.VS.Services.Governance.ComponentDetection.Contracts.csproj": { - "projectPath": "D:\\Source\\componentdetection-bcde\\src\\Contracts\\MS.VS.Services.Governance.ComponentDetection.Contracts.csproj" + "D:\\Source\\component-detection\\src\\Contracts\\MS.VS.Services.Governance.ComponentDetection.Contracts.csproj": { + "projectPath": "D:\\Source\\component-detection\\src\\Contracts\\MS.VS.Services.Governance.ComponentDetection.Contracts.csproj" }, - "D:\\Source\\componentdetection-bcde\\src\\Detectors\\MS.VS.Services.Governance.ComponentDetection.Detectors.csproj": { - "projectPath": "D:\\Source\\componentdetection-bcde\\src\\Detectors\\MS.VS.Services.Governance.ComponentDetection.Detectors.csproj" + "D:\\Source\\component-detection\\src\\Detectors\\MS.VS.Services.Governance.ComponentDetection.Detectors.csproj": { + "projectPath": "D:\\Source\\component-detection\\src\\Detectors\\MS.VS.Services.Governance.ComponentDetection.Detectors.csproj" }, - "D:\\Source\\componentdetection-bcde\\src\\Orchestrator\\MS.VS.Services.Governance.ComponentDetection.Orchestrator.csproj": { - "projectPath": "D:\\Source\\componentdetection-bcde\\src\\Orchestrator\\MS.VS.Services.Governance.ComponentDetection.Orchestrator.csproj", + "D:\\Source\\component-detection\\src\\Orchestrator\\MS.VS.Services.Governance.ComponentDetection.Orchestrator.csproj": { + "projectPath": "D:\\Source\\component-detection\\src\\Orchestrator\\MS.VS.Services.Governance.ComponentDetection.Orchestrator.csproj", "privateAssets": "all" } } @@ -9341,4 +9341,4 @@ } } } -} \ No newline at end of file +} diff --git a/test/Microsoft.ComponentDetection.Detectors.Tests/Resources/project_assets_2_2_additional.json b/test/Microsoft.ComponentDetection.Detectors.Tests/Resources/project_assets_2_2_additional.json index 8de9bf309..cfcd87497 100644 --- a/test/Microsoft.ComponentDetection.Detectors.Tests/Resources/project_assets_2_2_additional.json +++ b/test/Microsoft.ComponentDetection.Detectors.Tests/Resources/project_assets_2_2_additional.json @@ -4133,11 +4133,11 @@ "project": { "version": "1.0.0", "restore": { - "projectUniqueName": "D:\\Source\\componentdetection-bcde\\src\\Detectors\\MS.VS.Services.Governance.ComponentDetection.Detectors.csproj", + "projectUniqueName": "D:\\Source\\component-detection\\src\\Detectors\\MS.VS.Services.Governance.ComponentDetection.Detectors.csproj", "projectName": "Microsoft.VisualStudio.Services.Governance.ComponentDetection.Detectors", - "projectPath": "D:\\Source\\componentdetection-bcde\\src\\Detectors\\MS.VS.Services.Governance.ComponentDetection.Detectors.csproj", + "projectPath": "D:\\Source\\component-detection\\src\\Detectors\\MS.VS.Services.Governance.ComponentDetection.Detectors.csproj", "packagesPath": "C:\\Users\\brphelps\\.nuget\\packages\\", - "outputPath": "D:\\Source\\componentdetection-bcde\\src\\Detectors\\obj\\", + "outputPath": "D:\\Source\\component-detection\\src\\Detectors\\obj\\", "projectStyle": "PackageReference", "fallbackFolders": [ "C:\\Program Files\\dotnet\\sdk\\NuGetFallbackFolder" @@ -4156,11 +4156,11 @@ "frameworks": { "netcoreapp2.2": { "projectReferences": { - "D:\\Source\\componentdetection-bcde\\src\\Common\\MS.VS.Services.Governance.ComponentDetection.Common.csproj": { - "projectPath": "D:\\Source\\componentdetection-bcde\\src\\Common\\MS.VS.Services.Governance.ComponentDetection.Common.csproj" + "D:\\Source\\component-detection\\src\\Common\\MS.VS.Services.Governance.ComponentDetection.Common.csproj": { + "projectPath": "D:\\Source\\component-detection\\src\\Common\\MS.VS.Services.Governance.ComponentDetection.Common.csproj" }, - "D:\\Source\\componentdetection-bcde\\src\\Contracts\\MS.VS.Services.Governance.ComponentDetection.Contracts.csproj": { - "projectPath": "D:\\Source\\componentdetection-bcde\\src\\Contracts\\MS.VS.Services.Governance.ComponentDetection.Contracts.csproj" + "D:\\Source\\component-detection\\src\\Contracts\\MS.VS.Services.Governance.ComponentDetection.Contracts.csproj": { + "projectPath": "D:\\Source\\component-detection\\src\\Contracts\\MS.VS.Services.Governance.ComponentDetection.Contracts.csproj" } } } @@ -4291,4 +4291,4 @@ } } } - } \ No newline at end of file + }