breaking(module): migrate from tdabasinskas to datolabs-io (#69)

- Migrates repository from the personal space to an organization. - Will be released as `v3`. - Files moved to the root of repository, so `/backstage` suffix is no longer required in the `imports`.
datolabs-io · Nov 21, 2024 · 70c7823 · 70c7823
2 parents b35593e + 7cee082
commit 70c7823
Show file tree

Hide file tree

Showing 52 changed files with 87 additions and 37 deletions.
diff --git a/.cspell/custom-dictionary.txt b/.cspell/custom-dictionary.txt
diff --git a/.gitattributes b/.gitattributes
@@ -1,4 +1,5 @@
 * text=auto eol=lf
 
-go.sum              linguist-generated=true
-backstage/testdata/ linguist-generated=true
+go.sum                        linguist-generated=true
+testdata/*                    linguist-generated=true
+.cspell/custom-dictionary.txt linguist-generated=true
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1 +1 @@
-* @tdabasinskas
+* @datolabs-io/go-backstage-maintainers
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # go-backstage
 
-[![CI](https://github.com/tdabasinskas/go-backstage/actions/workflows/ci.yml/badge.svg)](https://github.com/tdabasinskas/go-backstage/actions/workflows/ci.yml)
-[![codecov](https://codecov.io/gh/tdabasinskas/go-backstage/branch/main/graph/badge.svg?token=4CVNSX7UOZ)](https://codecov.io/gh/tdabasinskas/go-backstage)
-[![Go Reference](https://pkg.go.dev/badge/github.com/tdabasinskas/go-backstage/backstage.svg)](https://pkg.go.dev/github.com/tdabasinskas/go-backstage/backstage)
+[![CI](https://github.com/datolabs-io/go-backstage/actions/workflows/ci.yml/badge.svg)](https://github.com/datolabs-io/go-backstage/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/datolabs-io/go-backstage/branch/main/graph/badge.svg?token=4CVNSX7UOZ)](https://codecov.io/gh/datolabs-io/go-backstage)
+[![Go Reference](https://pkg.go.dev/badge/github.com/datolabs-io/go-backstage/backstage.svg)](https://pkg.go.dev/github.com/datolabs-io/go-backstage/backstage)
 
 **go-backstage** is a Go client library for accessing the
 [Backstage REST API](https://backstage.io/docs/features/software-catalog/software-catalog-api).
@@ -15,28 +15,29 @@ the low-level details of making HTTP requests and parsing responses, allowing de
 With Go installed, run the following to add the package to your project, along with its dependencies:
 
 ```bash
-go get github.com/tdabasinskas/go-backstage/v2
+go get github.com/datolabs-io/go-backstage/v3
 ```
 
 Alternatively, you can add import the package as following and run `go get` to install it:
 
 ```go
-import "github.com/tdabasinskas/go-backstage/v2"
+import "github.com/datolabs-io/go-backstage/v3"
 ```
 
 ## Usage
 
 Add the package to your project as following:
 
 ```go
-import "github.com/tdabasinskas/go-backstage/v2"
+import "github.com/datolabs-io/go-backstage/v3"
 ```
 
 Once imported, create a new Backstage API client to access different parts of Backstage API:
 
 ```go
 client, err := backstage.NewClient(baseURL, "default", nil)
 ```
+
 If you want to use a custom HTTP client (for example, to handle authentication, retries or different timeouts), you can pass it as the
 third argument:
 

diff --git a/backstage/backstage.go → backstage.go b/backstage/backstage.go → backstage.go
diff --git a/backstage/backstage_test.go → backstage_test.go b/backstage/backstage_test.go → backstage_test.go
diff --git a/backstage/catalog.go → catalog.go b/backstage/catalog.go → catalog.go
diff --git a/backstage/catalog_test.go → catalog_test.go b/backstage/catalog_test.go → catalog_test.go
diff --git a/cspell.json b/cspell.json
@@ -0,0 +1,17 @@
+{
+    "version": "0.2",
+    "ignorePaths": [],
+    "dictionaryDefinitions": [
+        {
+            "name": "custom-dictionary",
+            "path": "./.cspell/custom-dictionary.txt",
+            "addWords": true
+        }
+    ],
+    "dictionaries": [
+        "custom-dictionary"
+    ],
+    "words": [],
+    "ignoreWords": [],
+    "import": []
+}
diff --git a/backstage/doc.go → doc.go b/backstage/doc.go → doc.go
@@ -5,25 +5,35 @@ Package backstage provides a client for the Backstage API.
 
 Add the package to your project as following:
 
-	import "github.com/tdabasinskas/go-backstage"
+```go
+import "github.com/datolabs-io/go-backstage/v3"
+```
 
 Once imported, create a new Backstage API client to access different parts of Backstage API:
 
-	client, err := backstage.NewClient(baseURL, "default", nil)
+```go
+client, err := backstage.NewClient(baseURL, "default", nil)
+```
 
 If you want to use a custom HTTP client (for example, to handle authentication, retries or different timeouts), you can pass it as the
 third argument:
 
-	httpClient := &http.Client{}
-	client, err := backstage.NewClient(baseURL, "default", httpClient)
+```go
+httpClient := &http.Client{}
+client, err := backstage.NewClient(baseURL, "default", httpClient)
+```
 
 The client than can be used to access different parts of the API, e.g. get the list of entities, sorted in specific order:
 
+```go
+
 	entities, response, err := c.Catalog.Entities.s.List(context.Background(), &ListEntityOptions{
-			Filters: ListEntityFilter{},
-			Fields:  []string{},
-			Order:   []ListEntityOrder{{ Direction: OrderDescending, Field: "metadata.name" },
-		},
+	        Filters: []string{},
+	        Fields:  []string{},
+	        Order:   []ListEntityOrder{{ Direction: OrderDescending, Field: "metadata.name" },
+	    },
 	})
+
+```
 */
 package backstage
diff --git a/backstage/entity.go → entity.go b/backstage/entity.go → entity.go
diff --git a/backstage/entity_test.go → entity_test.go b/backstage/entity_test.go → entity_test.go
diff --git a/examples/entities/go.mod b/examples/entities/go.mod
@@ -1,7 +1,7 @@
 module exampleentities
 
-go 1.22
+go 1.23
 
-replace github.com/tdabasinskas/go-backstage/v2 => ../..
+replace github.com/datolabs-io/go-backstage/v3 => ../..
 
-require github.com/tdabasinskas/go-backstage/v2 v2.0.0-preview.2
+require github.com/datolabs-io/go-backstage/v3 v3.0.0-00010101000000-000000000000
diff --git a/examples/entities/go.sum b/examples/entities/go.sum
diff --git a/examples/entities/main.go b/examples/entities/main.go
@@ -2,9 +2,10 @@ package main
 
 import (
 	"context"
-	"github.com/tdabasinskas/go-backstage/v2/backstage"
 	"log"
 	"os"
+
+	"github.com/datolabs-io/go-backstage/v3"
 )
 
 func main() {

diff --git a/examples/locations/go.mod b/examples/locations/go.mod
@@ -1,7 +1,7 @@
 module examplelocations
 
-go 1.22
+go 1.23
 
-replace github.com/tdabasinskas/go-backstage/v2 => ../..
+replace github.com/datolabs-io/go-backstage/v3 => ../..
 
-require github.com/tdabasinskas/go-backstage/v2 v2.0.0-preview.2
+require github.com/datolabs-io/go-backstage/v3 v3.0.0-00010101000000-000000000000
diff --git a/examples/locations/main.go b/examples/locations/main.go
@@ -6,11 +6,11 @@ import (
 	"net/http"
 	"os"
 
-	"github.com/tdabasinskas/go-backstage/v2/backstage"
+	"github.com/datolabs-io/go-backstage/v3"
 )
 
 func main() {
-	const locationTarget = "https://github.com/tdabasinskas/go-backstage/tree/main/backstage/testdata"
+	const locationTarget = "https://github.com/datolabs-io/go-backstage/tree/main/backstage/testdata"
 
 	baseURL, ok := os.LookupEnv("BACKSTAGE_BASE_URL")
 	if !ok {

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/tdabasinskas/go-backstage/v2
+module github.com/datolabs-io/go-backstage/v3
 
 go 1.23
 

diff --git a/backstage/kind_api.go → kind_api.go b/backstage/kind_api.go → kind_api.go
diff --git a/backstage/kind_api_test.go → kind_api_test.go b/backstage/kind_api_test.go → kind_api_test.go
diff --git a/backstage/kind_component.go → kind_component.go b/backstage/kind_component.go → kind_component.go
@@ -42,7 +42,7 @@ type ComponentEntityV1alpha1Spec struct {
 	ProvidesApis []string `json:"providesApis,omitempty" yaml:"providesApis,omitempty"`
 
 	// ConsumesApis is an array of entity references to the APIs that are consumed by the component.
-	ConsumesApis []string `json:"consumesApis,omitempty" yaml:"onsumesApis,omitempty"`
+	ConsumesApis []string `json:"consumesApis,omitempty" yaml:"consumesApis,omitempty"`
 
 	// DependsOn is an array of entity references to the components and resources that the component depends on.
 	DependsOn []string `json:"dependsOn,omitempty" yaml:"dependsOn,omitempty"`

diff --git a/backstage/kind_component_test.go → kind_component_test.go b/backstage/kind_component_test.go → kind_component_test.go
diff --git a/backstage/kind_domain.go → kind_domain.go b/backstage/kind_domain.go → kind_domain.go
diff --git a/backstage/kind_domain_test.go → kind_domain_test.go b/backstage/kind_domain_test.go → kind_domain_test.go
diff --git a/backstage/kind_group.go → kind_group.go b/backstage/kind_group.go → kind_group.go
diff --git a/backstage/kind_group_test.go → kind_group_test.go b/backstage/kind_group_test.go → kind_group_test.go
diff --git a/backstage/kind_location.go → kind_location.go b/backstage/kind_location.go → kind_location.go
diff --git a/backstage/kind_location_test.go → kind_location_test.go b/backstage/kind_location_test.go → kind_location_test.go
@@ -48,7 +48,7 @@ func TestKindLocationGet(t *testing.T) {
 // TestKindLocationCreateByID tests functionality of creating a new location.
 func TestKindLocationCreateByID(t *testing.T) {
 	const dataFile = "testdata/location_create.json"
-	const target = "https://github.com/tdabasinskas/go/backstage/test"
+	const target = "https://github.com/datolabs-io/go-backstage/test"
 
 	expected := LocationCreateResponse{}
 	expectedData, _ := os.ReadFile(dataFile)
@@ -88,7 +88,7 @@ func TestKindLocationCreateByID(t *testing.T) {
 // TestKindLocationCreateByID_DryRun tests functionality of creating a new location.
 func TestKindLocationCreateByID_DryRun(t *testing.T) {
 	const dataFile = "testdata/location_create_dryrun.json"
-	const target = "https://github.com/tdabasinskas/go/backstage/test"
+	const target = "https://github.com/datolabs-io/go-backstage/test"
 
 	expected := LocationCreateResponse{}
 	expectedData, _ := os.ReadFile(dataFile)

diff --git a/backstage/kind_resource.go → kind_resource.go b/backstage/kind_resource.go → kind_resource.go
diff --git a/backstage/kind_resource_test.go → kind_resource_test.go b/backstage/kind_resource_test.go → kind_resource_test.go
diff --git a/backstage/kind_system.go → kind_system.go b/backstage/kind_system.go → kind_system.go
diff --git a/backstage/kind_system_test.go → kind_system_test.go b/backstage/kind_system_test.go → kind_system_test.go
diff --git a/backstage/kind_user.go → kind_user.go b/backstage/kind_user.go → kind_user.go
diff --git a/backstage/kind_user_test.go → kind_user_test.go b/backstage/kind_user_test.go → kind_user_test.go
diff --git a/backstage/testdata/api.json → testdata/api.json b/backstage/testdata/api.json → testdata/api.json
diff --git a/backstage/testdata/catalog-info.yaml → testdata/catalog-info.yaml b/backstage/testdata/catalog-info.yaml → testdata/catalog-info.yaml
diff --git a/backstage/testdata/component.json → testdata/component.json b/backstage/testdata/component.json → testdata/component.json
diff --git a/backstage/testdata/domain.json → testdata/domain.json b/backstage/testdata/domain.json → testdata/domain.json
diff --git a/backstage/testdata/entities.json → testdata/entities.json b/backstage/testdata/entities.json → testdata/entities.json
diff --git a/backstage/testdata/entities_fields.json → testdata/entities_fields.json b/backstage/testdata/entities_fields.json → testdata/entities_fields.json
diff --git a/backstage/testdata/entities_filter.json → testdata/entities_filter.json b/backstage/testdata/entities_filter.json → testdata/entities_filter.json
diff --git a/backstage/testdata/entities_order.json → testdata/entities_order.json b/backstage/testdata/entities_order.json → testdata/entities_order.json
diff --git a/backstage/testdata/entities_single.json → testdata/entities_single.json b/backstage/testdata/entities_single.json → testdata/entities_single.json
diff --git a/backstage/testdata/group.json → testdata/group.json b/backstage/testdata/group.json → testdata/group.json
diff --git a/backstage/testdata/location.json → testdata/location.json b/backstage/testdata/location.json → testdata/location.json
diff --git a/backstage/testdata/location_by_id.json → testdata/location_by_id.json b/backstage/testdata/location_by_id.json → testdata/location_by_id.json
diff --git a/backstage/testdata/location_create.json → testdata/location_create.json b/backstage/testdata/location_create.json → testdata/location_create.json
diff --git a/...tage/testdata/location_create_dryrun.json → testdata/location_create_dryrun.json b/...tage/testdata/location_create_dryrun.json → testdata/location_create_dryrun.json
diff --git a/backstage/testdata/locations.json → testdata/locations.json b/backstage/testdata/locations.json → testdata/locations.json
diff --git a/backstage/testdata/resource.json → testdata/resource.json b/backstage/testdata/resource.json → testdata/resource.json
diff --git a/backstage/testdata/system.json → testdata/system.json b/backstage/testdata/system.json → testdata/system.json
diff --git a/backstage/testdata/user.json → testdata/user.json b/backstage/testdata/user.json → testdata/user.json
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		* @tdabasinskas
		* @datolabs-io/go-backstage-maintainers