From 3c37f5caf0d0f0ff87771432f0a2fe2a0a069b03 Mon Sep 17 00:00:00 2001 From: Luca Comellini Date: Wed, 8 Jan 2025 16:11:23 -0800 Subject: [PATCH] Update from nginxinc to nginx --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .github/workflows/dependency-review.yml | 2 +- .github/workflows/labeler.yml | 2 +- CHANGELOG.md | 36 ++++++++++++------------- CODEOWNERS | 2 +- CONTRIBUTING.md | 4 +-- README.md | 30 ++++++++++----------- compose.yaml | 4 +-- go.mod | 2 +- release-process.md | 16 +++++------ renovate.json | 2 +- tests/client_no_stream_test.go | 4 +-- tests/client_test.go | 4 +-- 13 files changed, 55 insertions(+), 55 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b9c0f981..193ee8c6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,7 +7,7 @@ that issue here in this description (not in the title of the PR). Before creating a PR, run through this checklist and mark each as complete. -- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/nginx-plus-go-client/blob/main/CONTRIBUTING.md) doc +- [ ] I have read the [CONTRIBUTING](https://github.com/nginx/nginx-plus-go-client/blob/main/CONTRIBUTING.md) doc - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have checked that all unit tests pass after adding my changes - [ ] I have updated necessary documentation diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml index 93ee2b05..d1be1aff 100644 --- a/.github/workflows/dependency-review.yml +++ b/.github/workflows/dependency-review.yml @@ -29,4 +29,4 @@ jobs: - name: Dependency Review uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0 with: - config-file: "nginxinc/k8s-common/dependency-review-config.yml@main" + config-file: "nginx/k8s-common/dependency-review-config.yml@main" diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml index 443756d6..7d9e31de 100644 --- a/.github/workflows/labeler.yml +++ b/.github/workflows/labeler.yml @@ -17,7 +17,7 @@ jobs: sparse-checkout: | labeler.yml sparse-checkout-cone-mode: false - repository: nginxinc/k8s-common + repository: nginx/k8s-common - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0 with: diff --git a/CHANGELOG.md b/CHANGELOG.md index bfd9115d..88c57ba1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,14 +1,14 @@ # Changelog -Starting with version 0.8.0, an automatically generated list of changes can be found on the [GitHub Releases page](https://github.com/nginxinc/nginx-plus-go-client/releases). +Starting with version 0.8.0, an automatically generated list of changes can be found on the [GitHub Releases page](https://github.com/nginx/nginx-plus-go-client/releases). ## 0.7.0 (Jul 10, 2020) FEATURES: -- [38](https://github.com/nginxinc/nginx-plus-go-client/pull/38): *Support for /slabs API endpoint*. The client now +- [38](https://github.com/nginx/nginx-plus-go-client/pull/38): _Support for /slabs API endpoint_. The client now supports retrieving shared memory zone usage info. -- [41](https://github.com/nginxinc/nginx-plus-go-client/pull/41): *Support for /processes API endpoint*. The client now +- [41](https://github.com/nginx/nginx-plus-go-client/pull/41): _Support for /processes API endpoint_. The client now supports retrieving processes info. CHANGES: @@ -20,7 +20,7 @@ CHANGES: FEATURES: -- [34](https://github.com/nginxinc/nginx-plus-go-client/pull/34): *Support for updating upstream servers parameters*. +- [34](https://github.com/nginx/nginx-plus-go-client/pull/34): _Support for updating upstream servers parameters_. The client now supports updating upstream parameters of servers that already exist in NGINX Plus. CHANGES: @@ -35,14 +35,14 @@ CHANGES: FEATURES: -- [30](https://github.com/nginxinc/nginx-plus-go-client/pull/30): *Support additional upstream server parameters*. The -client now supports configuring `route`, `backup`, `down`, `drain`, `weight` and `service` parameters for http -upstreams and `backup`, `down`, `weight` and `service` parameters for stream upstreams. -- [31](https://github.com/nginxinc/nginx-plus-go-client/pull/31): *Support location zones and resolver metrics*. +- [30](https://github.com/nginx/nginx-plus-go-client/pull/30): _Support additional upstream server parameters_. The + client now supports configuring `route`, `backup`, `down`, `drain`, `weight` and `service` parameters for http + upstreams and `backup`, `down`, `weight` and `service` parameters for stream upstreams. +- [31](https://github.com/nginx/nginx-plus-go-client/pull/31): _Support location zones and resolver metrics_. FIXES: -- [29](https://github.com/nginxinc/nginx-plus-go-client/pull/29): *Fix max_fails parameter in upstream servers*. +- [29](https://github.com/nginx/nginx-plus-go-client/pull/29): _Fix max_fails parameter in upstream servers_. Previously, if the MaxFails field was not explicitly set, the client would incorrectly configure an upstream with the value `0` instead of the correct value `1`. @@ -55,36 +55,36 @@ CHANGES: FEATURES: -- [24](https://github.com/nginxinc/nginx-plus-go-client/pull/24): *Support `MaxConns` in upstream servers*. +- [24](https://github.com/nginx/nginx-plus-go-client/pull/24): _Support `MaxConns` in upstream servers_. FIXES: -- [25](https://github.com/nginxinc/nginx-plus-go-client/pull/25): *Fix session metrics for stream server zones*. Session +- [25](https://github.com/nginx/nginx-plus-go-client/pull/25): _Fix session metrics for stream server zones_. Session metrics with a status of `4xx` or `5xx` are now correctly reported. Previously they were always reported as `0`. ## 0.3.1 (June 10, 2019) CHANGES: -- [22](https://github.com/nginxinc/nginx-plus-go-client/pull/22): *Change in stream zone sync metrics*. `StreamZoneSync` +- [22](https://github.com/nginx/nginx-plus-go-client/pull/22): _Change in stream zone sync metrics_. `StreamZoneSync` field of the `Stats` type is now a pointer. It will be nil if NGINX Plus doesn't report any zone sync stats. ## 0.3 (May 29, 2019) FEATURES: -- [20](https://github.com/nginxinc/nginx-plus-go-client/pull/20): *Support for stream zone sync metrics*. The client +- [20](https://github.com/nginx/nginx-plus-go-client/pull/20): _Support for stream zone sync metrics_. The client `GetStats` method now additionally returns stream zone sync metrics. -- [13](https://github.com/nginxinc/nginx-plus-go-client/pull/13): *Support for key-value endpoints*. The client +- [13](https://github.com/nginx/nginx-plus-go-client/pull/13): _Support for key-value endpoints_. The client implements a set of methods to create/modify/delete key-val pairs for both http and stream contexts. -- [12](https://github.com/nginxinc/nginx-plus-go-client/pull/12) *Support for NGINX status info*. The client `GetStats` +- [12](https://github.com/nginx/nginx-plus-go-client/pull/12) _Support for NGINX status info_. The client `GetStats` method now additionally returns NGINX status metrics. Thanks to [jthurman42](https://github.com/jthurman42). CHANGES: - The repository was renamed to `nginx-plus-go-client` instead of `nginx-plus-go-sdk`. If the client is used as a dependency, this name needs to be changed in the import section (`import - "github.com/nginxinc/nginx-plus-go-client/client"`). +"github.com/nginxinc/nginx-plus-go-client/client"`). - The version of the API was changed to 4. - The version of NGINX Plus for e2e testing was changed to R18. @@ -92,8 +92,8 @@ CHANGES: FEATURES: -- [7](https://github.com/nginxinc/nginx-plus-go-sdk/pull/7): *Support for stream server zone and stream upstream - metrics*. The client `GetStats` method now additionally returns stream server zone and stream upstream metrics. +- [7](https://github.com/nginx/nginx-plus-go-client/pull/7): _Support for stream server zone and stream upstream + metrics_. The client `GetStats` method now additionally returns stream server zone and stream upstream metrics. CHANGES: diff --git a/CODEOWNERS b/CODEOWNERS index 77ed024e..47d9e595 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1 +1 @@ -* @nginxinc/integrations +* @nginx/integrations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce4f0c67..2d617150 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ considering contributing! ## Ask a Question -To ask a question please use [Github Discussions](https://github.com/nginxinc/nginx-plus-go-client/discussions). +To ask a question please use [Github Discussions](https://github.com/nginx/nginx-plus-go-client/discussions). You can also join our [Community Slack](https://community.nginx.org/joinslack) which has a wider NGINX audience. @@ -90,6 +90,6 @@ can be merged. Your agreement signature will be safely stored by F5 and no longe - Run `gofmt` over your code to automatically resolve a lot of style issues. Most editors support this running automatically when saving a code file. - Run `go lint` and `go vet` on your code too to catch any other issues. -- Follow this guide on some good practice and idioms for Go - +- Follow this guide on some good practice and idioms for Go - - To check for extra issues, install [golangci-lint](https://github.com/golangci/golangci-lint) and run `make lint` or `golangci-lint run` diff --git a/README.md b/README.md index 7101e710..06e78ded 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -[![OpenSSFScorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/nginx-plus-go-client/badge)](https://scorecard.dev/viewer/?uri=github.com/nginxinc/nginx-plus-go-client) -[![Continuous Integration](https://github.com/nginxinc/nginx-plus-go-client/workflows/Continuous%20Integration/badge.svg)](https://github.com/nginxinc/nginx-plus-go-client/actions) +[![OpenSSFScorecard](https://api.securityscorecards.dev/projects/github.com/nginx/nginx-plus-go-client/badge)](https://scorecard.dev/viewer/?uri=github.com/nginx/nginx-plus-go-client) +[![Continuous Integration](https://github.com/nginx/nginx-plus-go-client/workflows/Continuous%20Integration/badge.svg)](https://github.com/nginx/nginx-plus-go-client/actions) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -[![Go Report Card](https://goreportcard.com/badge/github.com/nginxinc/nginx-plus-go-client)](https://goreportcard.com/report/github.com/nginxinc/nginx-plus-go-client) -[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B5618%2Fgithub.com%2Fnginxinc%2Fnginx-plus-go-client.svg?type=shield)](https://app.fossa.com/projects/custom%2B5618%2Fgithub.com%2Fnginxinc%2Fnginx-plus-go-client?ref=badge_shield) -[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nginxinc/nginx-plus-go-client?logo=github&sort=semver)](https://github.com/nginxinc/nginx-plus-go-client/releases/latest) -![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nginxinc/nginx-plus-go-client?logo=go) +[![Go Report Card](https://goreportcard.com/badge/github.com/nginx/nginx-plus-go-client)](https://goreportcard.com/report/github.com/nginx/nginx-plus-go-client) +[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B5618%2Fgithub.com%2Fnginx%2Fnginx-plus-go-client.svg?type=shield)](https://app.fossa.com/projects/custom%2B5618%2Fgithub.com%2Fnginx%2Fnginx-plus-go-client?ref=badge_shield) +[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nginx/nginx-plus-go-client?logo=github&sort=semver)](https://github.com/nginx/nginx-plus-go-client/releases/latest) +![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nginx/nginx-plus-go-client?logo=go) [![Slack](https://img.shields.io/badge/slack-nginxcommunity-green?logo=slack)](https://nginxcommunity.slack.com) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) -[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/nginx-plus-go-client/blob/main/SECURITY.md) +[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginx/nginx-plus-go-client/blob/main/SECURITY.md) # NGINX Plus Go Client @@ -41,17 +41,17 @@ This Client works against versions 4 to 9 of the NGINX Plus API. The table below the API was first introduced. | API version | NGINX Plus version | -|-------------|--------------------| -| 4 | R18 | -| 5 | R19 | -| 6 | R20 | -| 7 | R25 | -| 8 | R27 | -| 9 | R30 | +| ----------- | ------------------ | +| 4 | R18 | +| 5 | R19 | +| 6 | R20 | +| 7 | R25 | +| 8 | R27 | +| 9 | R30 | ## Using the Client -1. Import `github.com/nginxinc/nginx-plus-go-client/client` into your go project. +1. Import `github.com/nginx/nginx-plus-go-client/client` into your go project. 2. Use your favorite vendor tool to add this to your `/vendor` directory in your project. ## Testing diff --git a/compose.yaml b/compose.yaml index 153ffc90..d1b0433c 100644 --- a/compose.yaml +++ b/compose.yaml @@ -33,8 +33,8 @@ services: volumes: - type: bind source: ./ - target: /go/src/github.com/nginxinc/nginx-plus-go-client - working_dir: /go/src/github.com/nginxinc/nginx-plus-go-client + target: /go/src/github.com/nginx/nginx-plus-go-client + working_dir: /go/src/github.com/nginx/nginx-plus-go-client command: go test -v -shuffle=on -race tests/client_test.go depends_on: - nginx diff --git a/go.mod b/go.mod index ca1fc76f..a94427da 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/nginxinc/nginx-plus-go-client/v2 +module github.com/nginx/nginx-plus-go-client/v2 go 1.22.6 diff --git a/release-process.md b/release-process.md index e3bc9b53..bdb41cc4 100644 --- a/release-process.md +++ b/release-process.md @@ -19,7 +19,7 @@ The project follows [Semantic Versioning](https://semver.org/) for versioning. ## Release Planning and Development The features that will go into the next release are reflected in the -corresponding [milestone](https://github.com/nginxinc/nginx-plus-go-client/milestones). Refer to +corresponding [milestone](https://github.com/nginx/nginx-plus-go-client/milestones). Refer to the [Issue Lifecycle](/ISSUE_LIFECYCLE.md) document for information on issue creation and assignment to releases. ## Releasing a New Version @@ -27,13 +27,13 @@ the [Issue Lifecycle](/ISSUE_LIFECYCLE.md) document for information on issue cre 1. Create an issue to define and track release-related activities. Choose a title that follows the format `Release X.Y.Z`. 2. Stop merging any new work into the main branch. -3. Check the release draft under the [GitHub releases](https://github.com/nginxinc/nginx-plus-go-client/releases) page -to ensure that everything is in order. +3. Check the release draft under the [GitHub releases](https://github.com/nginx/nginx-plus-go-client/releases) page + to ensure that everything is in order. 4. Create and push the release tag in the format `vX.Y.Z`: - ```bash - git tag -a vX.Y.Z -m "Release vX.Y.Z" - git push origin vX.Y.Z - ``` + ```bash + git tag -a vX.Y.Z -m "Release vX.Y.Z" + git push origin vX.Y.Z + ``` - As a result, the CI/CD pipeline will publish the release and announce it in the community Slack. + As a result, the CI/CD pipeline will publish the release and announce it in the community Slack. diff --git a/renovate.json b/renovate.json index 8bf65f91..891b5869 100644 --- a/renovate.json +++ b/renovate.json @@ -1,7 +1,7 @@ { "$schema": "https://docs.renovatebot.com/renovate-schema.json", "extends": [ - "github>nginxinc/k8s-common", + "github>nginx/k8s-common", "schedule:earlyMondays" ] } diff --git a/tests/client_no_stream_test.go b/tests/client_no_stream_test.go index 2ec1da93..2e85fea5 100644 --- a/tests/client_no_stream_test.go +++ b/tests/client_no_stream_test.go @@ -4,8 +4,8 @@ import ( "context" "testing" - "github.com/nginxinc/nginx-plus-go-client/v2/client" - "github.com/nginxinc/nginx-plus-go-client/v2/tests/helpers" + "github.com/nginx/nginx-plus-go-client/v2/client" + "github.com/nginx/nginx-plus-go-client/v2/tests/helpers" ) // TestStatsNoStream tests the peculiar behavior of getting Stream-related diff --git a/tests/client_test.go b/tests/client_test.go index 1217f5ad..4f1fe6fa 100644 --- a/tests/client_test.go +++ b/tests/client_test.go @@ -7,8 +7,8 @@ import ( "testing" "time" - "github.com/nginxinc/nginx-plus-go-client/v2/client" - "github.com/nginxinc/nginx-plus-go-client/v2/tests/helpers" + "github.com/nginx/nginx-plus-go-client/v2/client" + "github.com/nginx/nginx-plus-go-client/v2/tests/helpers" ) const (