docs: mark packages as deprecated

sylabs · Sep 14, 2021 · 1d6dc7c · 1d6dc7c
1 parent 26f00a3
commit 1d6dc7c
Show file tree

Hide file tree

Showing 19 changed files with 30 additions and 16 deletions.
diff --git a/cmd/siftool/modif.go b/cmd/siftool/modif.go
@@ -13,7 +13,7 @@ import (
 	"strconv"
 
 	"github.com/sylabs/sif/internal/app/siftool"
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 var (

diff --git a/cmd/siftool/siftool.go b/cmd/siftool/siftool.go
@@ -14,7 +14,7 @@ import (
 	"os"
 	"runtime"
 
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 var usageMessage = `siftool is a utility program for manipulating SIF files.

diff --git a/internal/app/siftool/file.go b/internal/app/siftool/file.go
@@ -6,7 +6,7 @@
 package siftool
 
 import (
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 // withFileImage calls fn with a FileImage loaded from path.

diff --git a/internal/app/siftool/info.go b/internal/app/siftool/info.go
@@ -14,7 +14,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 // Header displays a SIF file global header.

diff --git a/internal/app/siftool/modif.go b/internal/app/siftool/modif.go
@@ -12,7 +12,7 @@ import (
 	"io"
 
 	uuid "github.com/satori/go.uuid"
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 // New creates a new empty SIF file.

diff --git a/pkg/integrity/digest.go b/pkg/integrity/digest.go
@@ -15,7 +15,7 @@ import (
 	"io"
 	"strings"
 
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 var (

diff --git a/pkg/integrity/digest_test.go b/pkg/integrity/digest_test.go
@@ -17,7 +17,7 @@ import (
 	"testing"
 
 	"github.com/sebdah/goldie/v2"
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 func TestNewLegacyDigest(t *testing.T) {

diff --git a/pkg/integrity/doc.go b/pkg/integrity/doc.go
@@ -42,5 +42,10 @@ on object group 1 only:
 Finally, to perform cryptographic verification:
 
 	err := v.Verify()
+
+Deprecated: this package is deprecated. Users should migrate applications to package
+github.com/sylabs/sif/v2/pkg/integrity.
+
+This package is frozen and no new functionality will be added.
 */
 package integrity
diff --git a/pkg/integrity/metadata.go b/pkg/integrity/metadata.go
@@ -13,7 +13,7 @@ import (
 	"fmt"
 	"io"
 
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 var (

diff --git a/pkg/integrity/metadata_test.go b/pkg/integrity/metadata_test.go
@@ -19,7 +19,7 @@ import (
 
 	uuid "github.com/satori/go.uuid"
 	"github.com/sebdah/goldie/v2"
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 func TestWriteHeader(t *testing.T) {

diff --git a/pkg/integrity/result.go b/pkg/integrity/result.go
@@ -6,7 +6,7 @@
 package integrity
 
 import (
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 	"golang.org/x/crypto/openpgp"
 )
 

diff --git a/pkg/integrity/select.go b/pkg/integrity/select.go
@@ -12,7 +12,7 @@ import (
 	"io"
 	"sort"
 
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 var (

diff --git a/pkg/integrity/sign.go b/pkg/integrity/sign.go
@@ -13,7 +13,7 @@ import (
 	"fmt"
 	"sort"
 
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 	"golang.org/x/crypto/openpgp"
 	"golang.org/x/crypto/openpgp/packet"
 )

diff --git a/pkg/integrity/sign_test.go b/pkg/integrity/sign_test.go
@@ -15,7 +15,7 @@ import (
 	"testing"
 
 	"github.com/sebdah/goldie/v2"
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 	"golang.org/x/crypto/openpgp"
 	"golang.org/x/crypto/openpgp/packet"
 )

diff --git a/pkg/integrity/verify.go b/pkg/integrity/verify.go
@@ -13,7 +13,7 @@ import (
 	"sort"
 	"strings"
 
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 	"golang.org/x/crypto/openpgp"
 )
 

diff --git a/pkg/integrity/verify_test.go b/pkg/integrity/verify_test.go
@@ -12,7 +12,7 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 	"golang.org/x/crypto/openpgp"
 	pgperrors "golang.org/x/crypto/openpgp/errors"
 )

diff --git a/pkg/sif/sif.go b/pkg/sif/sif.go
@@ -80,6 +80,10 @@
 //     | .                                              |
 //     `================================================'
 //
+// Deprecated: this package is deprecated. Users should migrate applications to package
+// github.com/sylabs/sif/v2/pkg/sif.
+//
+// This package is frozen and no new functionality will be added.
 package sif
 
 import (

diff --git a/pkg/siftool/add.go b/pkg/siftool/add.go
@@ -13,7 +13,7 @@ import (
 
 	"github.com/spf13/cobra"
 	"github.com/sylabs/sif/internal/app/siftool"
-	"github.com/sylabs/sif/pkg/sif"
+	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
 )
 
 // Add implements 'siftool add' sub-command.

diff --git a/pkg/siftool/siftool.go b/pkg/siftool/siftool.go
@@ -7,6 +7,11 @@
 
 // Package siftool implements cobra.Command structs for the siftool functionality. This
 // allows for easy inclusion of siftool functions in the singularity cli.
+//
+// Deprecated: this package is deprecated. Users should migrate applications to package
+// github.com/sylabs/sif/v2/pkg/siftool.
+//
+// This package is frozen and no new functionality will be added.
 package siftool
 
 import (
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,7 +14,7 @@ import ( @@
     	"os"
     	"time"
-    	"github.com/sylabs/sif/pkg/sif"
+    	"github.com/sylabs/sif/pkg/sif" //nolint:staticcheck // In use until v2 API
     )
     // Header displays a SIF file global header.
@@ Expand Down @@