Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🌱 Deprecate dependencydiff package #3125

Merged
merged 2 commits into from
Jun 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion dependencydiff/dependencydiff.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand All @@ -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 {
Expand All @@ -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.
Expand Down