Skip to content

Commit dc4ff9e

Browse files
authored
chore: Rename realm occurrences to Atlas App Services & update Go version (#4)
1 parent eee8327 commit dc4ff9e

File tree

12 files changed

+35
-26
lines changed

12 files changed

+35
-26
lines changed

.github/ISSUE_TEMPLATE/config.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: MongoDB Realm Support
3+
- name: MongoDB Atlas App Services Support
44
url: https://support.mongodb.com/
55
about: Support is provided under MongoDB support plans. Please submit support questions within the Realm UI.
6-
- name: MongoDB Realm
7-
url: https://www.mongodb.com/realm
8-
about: Learn more about MongoDB Realm
6+
- name: MongoDB MongoDB Atlas App Services
7+
url: https://www.mongodb.com/docs/atlas/app-services/
8+
about: Learn more about MongoDB MongoDB Atlas App Services

.github/workflows/pr.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
- name: Install Go
1616
uses: actions/setup-go@v5
1717
with:
18-
go-version: 1.18
18+
go-version: 1.23
1919
- name: lint
2020
uses: golangci/[email protected]
2121
with:
@@ -27,8 +27,8 @@ jobs:
2727
strategy:
2828
matrix:
2929
golang:
30-
- 1.18
31-
- 1.19
30+
- 1.23
31+
3232
steps:
3333
- name: Checkout repository
3434
uses: actions/checkout@v4

CODEOWNERS

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Maintained by the MongoDB APIx-Integrations team
2+
* @mongodb-labs/apix-integrations

Makefile

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
# A Self-Documenting Makefile: http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
22

33
SOURCE_FILES?=./...
4-
GOLANGCI_VERSION=v1.40.1
4+
GOLANGCI_VERSION=v1.62.2
55
COVERAGE=coverage.out
66

77
export PATH := ./bin:$(PATH)
88
export GO111MODULE := on
99

10+
default: build
11+
12+
.PHONY: build
13+
build: ## Compile code
14+
go install $(SOURCE_FILES)
15+
1016
.PHONY: setup
1117
setup: ## Install dev tools
1218
@echo "==> Installing dependencies..."

README.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
1-
# go-client-mongodb-realm
1+
# go-client-mongodb-atlas-app-services (WIP)
22
[![PkgGoDev](https://pkg.go.dev/badge/go.mongodb.org/realm)](https://pkg.go.dev/go.mongodb.org/realm)
33

4-
A Go HTTP client for the [MongoDB Realm API](https://docs.mongodb.com/realm/admin/api/v3/).
5-
6-
Note that Realm only supports the two most recent major versions of Go.
4+
A Go HTTP client for the [MongoDB Atlas App Services Admin API](https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/).
75

86
## Usage
97

108
```go
11-
import "go.mongodb.org/realm/realm"
9+
import "go.mongodb.org/atlas-appservices/appservices"
1210
```
1311

14-
Construct a new Realm client, then use the various services on the client to
12+
Construct a new App Services client, then use the various services on the client to
1513
access different parts of the Atlas API. For example:
1614

1715
```go
18-
client := realm.NewClient(nil)
16+
client := appservices.NewClient(nil)
1917
```
2018

2119
The services of a client divide the API into logical chunks and correspond to
2220
the structure of the Atlas API documentation at
23-
https://docs.mongodb.com/realm/admin/api/v3/.
21+
https://www.mongodb.com/docs/atlas/app-services/admin/api/v3/.
2422

2523
**NOTE:** Using the [context](https://godoc.org/context) package, one can easily
2624
pass cancellation signals and deadlines to various services of the client for
@@ -33,7 +31,7 @@ Each version of the client is tagged, and the version is updated accordingly.
3331

3432
To see the list of past versions, run `git tag`.
3533

36-
To release a new version, first ensure that [Version](./realm/realm.go) is updated
34+
To release a new version, first ensure that [Version](./appservices/appservices.go) is updated
3735
(i.e., before running `git push origin vx.y.z`, verify that `Version=x.y.z` should match the tag being pushed to GitHub)
3836

3937
## Roadmap
@@ -48,4 +46,4 @@ See our [CONTRIBUTING.md](CONTRIBUTING.md) Guide.
4846

4947
## License
5048

51-
`go-client-mongodb-realm` is released under the Apache 2.0 license. See [LICENSE](LICENSE)
49+
`go-client-mongodb-atlas-app-services` is released under the Apache 2.0 license. See [LICENSE](LICENSE)

realm/apps.go renamed to appservices/apps.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package realm
15+
package appservices
1616

1717
import (
1818
"context"

realm/apps_test.go renamed to appservices/apps_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package realm
15+
package appservices
1616

1717
import (
1818
"fmt"

realm/realm.go renamed to appservices/appservices.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package realm // import "go.mongodb.org/realm/realm"
15+
package appservices // import "go.mongodb.org/realm/realm"
1616

1717
import (
1818
"bytes"
@@ -28,6 +28,7 @@ import (
2828
"strings"
2929

3030
"github.com/google/go-querystring/query"
31+
3132
"go.mongodb.org/atlas/mongodbatlas"
3233
)
3334

realm/realm_test.go renamed to appservices/appservices_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package realm
15+
package appservices
1616

1717
import (
1818
"context"

realm/event_triggers.go renamed to appservices/event_triggers.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package realm
15+
package appservices
1616

1717
import (
1818
"context"

realm/event_triggers_test.go renamed to appservices/event_triggers_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package realm
15+
package appservices
1616

1717
import (
1818
"encoding/json"

go.mod

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
module go.mongodb.org/realm
1+
module go.mongodb.org/atlas-appservices
22

3-
go 1.18
3+
go 1.23
4+
5+
toolchain go1.23.1
46

57
require (
68
github.com/go-test/deep v1.1.1

0 commit comments

Comments
 (0)