🌱 Deprecate dependencydiff package and add access token requirement (#…

…3125) - Deprecate the `dependencydiff` package and the `GetDependencyDiffResults` function - Add a line to the `.codecov.yml` to ignore the `dependencydiff` package Signed-off-by: naveensrinivasan <[email protected]>
ossf · Jun 7, 2023 · ab0d078 · ab0d078
1 parent f43c9c9
commit ab0d078
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.codecov.yml b/.codecov.yml
@@ -12,6 +12,8 @@ ignore:
   - "docs/**/*"
   # this is the runner
   - "main.go"
+  # this package is deprecated and going to be removed.
+  - "dependencydiff/**/*"
 
 coverage:
   precision: 2

diff --git a/dependencydiff/dependencydiff.go b/dependencydiff/dependencydiff.go
@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Deprecated: This is going to be removed in the future.
 package dependencydiff
 
 import (
@@ -29,7 +30,9 @@ import (
 )
 
 // Depdiff is the exported name for dependency-diff.
-const Depdiff = "Dependency-diff"
+const (
+	Depdiff = "Dependency-diff"
+)
 
 // A private context struct used for GetDependencyCheckResults.
 type dependencydiffContext struct {
@@ -47,6 +50,7 @@ type dependencydiffContext struct {
 	results                         []pkg.DependencyCheckResult
 }
 
+// Deprecated: This is going to be removed in the future.
 // GetDependencyDiffResults gets dependency changes between two given code commits BASE and HEAD
 // along with the Scorecard check results of the dependencies, and returns a slice of DependencyCheckResult.
 // TO use this API, an access token must be set. See https://github.com/ossf/scorecard#authentication.