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

Update csharp.md to indicate ConnectAsync is deprecated #3866

Merged
merged 8 commits into from
Jun 21, 2024

Conversation

aallbrig
Copy link
Contributor

@aallbrig aallbrig commented Jun 11, 2024

What type of PR is this?
/kind documentation

What this PR does / Why we need it:
As I was following the AgonesSDK C# guide I noticed that when I tried using ConnectAsync the function has actually been deprecated. It'd be good to get verbiage into the documentation so other Agones users know they don't have to use this method any longer.

Screenshot 2024-06-11 at 12 08 18 PM
Screenshot 2024-06-11 at 12 08 25 PM
Source @ agones/sdks/csharp/sdk/AgonesSDK.cs#112

Which issue(s) this PR fixes:

Closes #

Special notes for your reviewer:
Unsure if a strike through is desired or if the documentation block should just be completely removed. Let me know what you'd prefer. If I don't respond quickly enough please feel free to take on the documentation changes outside this PR.

@github-actions github-actions bot added kind/documentation Documentation for Agones size/XS labels Jun 11, 2024
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: e624feb0-630a-457f-9942-11be0abf45ec

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3866/head:pr_3866 && git checkout pr_3866
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-5b6584a-amd64

@markmandel
Copy link
Member

@igooch , @zmerlynn - given the new SDK compatibility standards, I think we can delete this ConnectAsync function from the C# SDK, since it actually does nothing?

Or since it was implemented 9 months ago, we have to wait another 3 months?

@igooch
Copy link
Collaborator

igooch commented Jun 12, 2024

We guarantee the SDK Server compatibility, not the Client SDK implementation, so we're technically fine to remove it.

@markmandel
Copy link
Member

We guarantee the SDK Server compatibility, not the Client SDK implementation, so we're technically fine to remove it.

Sounds like - this PR should delete the method entirely (label as kind/breaking) and update the SDK docs to feature shortcode hide the SDK method for the next version of Agones.

What do we think?

@zmerlynn
Copy link
Collaborator

We guarantee the SDK Server compatibility, not the Client SDK implementation, so we're technically fine to remove it.

Sounds like - this PR should delete the method entirely (label as kind/breaking) and update the SDK docs to feature shortcode hide the SDK method for the next version of Agones.

What do we think?

Agreed.

@markmandel
Copy link
Member

markmandel commented Jun 13, 2024

@aallbrig - you up for this change? 😄

@aallbrig
Copy link
Contributor Author

aallbrig commented Jun 16, 2024 via email

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 213a5d1e-fedc-44ae-98e8-c27e2dc0b0ec

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3866/head:pr_3866 && git checkout pr_3866
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-4d77f76-amd64

@aallbrig
Copy link
Contributor Author

@markmandel this change is ready to re-review!

Copy link
Collaborator

@igooch igooch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good. There's a line towards the bottom of the csharp.md file - All requests other than ConnectAsync will wait for up to 15 seconds before giving up, time to wait can also be set in the constructor.. You can modify similar to how you did with {{% feature expiryVersion="1.42.0" %}}.

site/content/en/docs/Guides/Client SDKs/csharp.md Outdated Show resolved Hide resolved
site/content/en/docs/Guides/Client SDKs/csharp.md Outdated Show resolved Hide resolved
@aallbrig
Copy link
Contributor Author

@igooch Added in suggested commits and added the expiry feature flag around ConnectAsync remark. Merged latest from main. Thanks for reviewing!

@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: 945a6c44-33d8-4429-9420-0e3df838a1c5

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

Copy link
Collaborator

@igooch igooch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last item then LGTM.

Co-authored-by: igooch <igooch@google.com>
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: c008d695-a615-4465-b5e3-a702b55eaed7

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3866/head:pr_3866 && git checkout pr_3866
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-01f6951-amd64

Copy link
Collaborator

@igooch igooch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@igooch igooch enabled auto-merge (squash) June 21, 2024 16:07
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 59e2cb1f-4df2-4497-a3f2-0053990a8b0d

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/googleforgames/agones.git pull/3866/head:pr_3866 && git checkout pr_3866
  • helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-7658296-amd64

@igooch igooch merged commit 2c60194 into googleforgames:main Jun 21, 2024
4 checks passed
@markmandel markmandel added the kind/breaking Breaking change label Jul 15, 2024
@aallbrig aallbrig deleted the patch-1 branch July 19, 2024 22:55
spiceratops referenced this pull request in spiceratops/k8s-gitops Jul 23, 2024
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [agones](https://agones.dev)
([source](https://togithub.com/googleforgames/agones)) | minor |
`1.41.0` -> `1.42.0` |

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>googleforgames/agones (agones)</summary>

###
[`v1.42.0`](https://togithub.com/googleforgames/agones/blob/HEAD/CHANGELOG.md#v1420-2024-07-16)

[Compare
Source](https://togithub.com/googleforgames/agones/compare/v1.41.0...v1.42.0)

[Full
Changelog](https://togithub.com/googleforgames/agones/compare/v1.41.0...v1.42.0)

**Breaking changes:**

- Update csharp.md to indicate ConnectAsync is deprecated by
[@&#8203;aallbrig](https://togithub.com/aallbrig) in
[https://github.com/googleforgames/agones/pull/3866](https://togithub.com/googleforgames/agones/pull/3866)

**Implemented enhancements:**

- Add security context to Agones containers by
[@&#8203;peterzhongyi](https://togithub.com/peterzhongyi) in
[https://github.com/googleforgames/agones/pull/3856](https://togithub.com/googleforgames/agones/pull/3856)
- Add Security Context to game server sidecar by
[@&#8203;peterzhongyi](https://togithub.com/peterzhongyi) in
[https://github.com/googleforgames/agones/pull/3869](https://togithub.com/googleforgames/agones/pull/3869)
- Drop CountsAndLists Data from the Fleet and Game Server Set When the
Flag is False by [@&#8203;igooch](https://togithub.com/igooch) in
[https://github.com/googleforgames/agones/pull/3881](https://togithub.com/googleforgames/agones/pull/3881)
- Adds tests to confirm that Fleet, Fleet Autoscaler, and Fleet
Allocation apply defaults code is idempotent by
[@&#8203;igooch](https://togithub.com/igooch) in
[https://github.com/googleforgames/agones/pull/3888](https://togithub.com/googleforgames/agones/pull/3888)
- feat: Add CRD Changes and Feature Flag for chain policy by
[@&#8203;indexjoseph](https://togithub.com/indexjoseph) in
[https://github.com/googleforgames/agones/pull/3880](https://togithub.com/googleforgames/agones/pull/3880)

**Fixed bugs:**

- sdk-server expects SDK_LOG_LEVEL by
[@&#8203;KAllan357](https://togithub.com/KAllan357) in
[https://github.com/googleforgames/agones/pull/3858](https://togithub.com/googleforgames/agones/pull/3858)
- this will resolve From/layer extraction issue on ltsc2019 in examples
by [@&#8203;ashutosji](https://togithub.com/ashutosji) in
[https://github.com/googleforgames/agones/pull/3873](https://togithub.com/googleforgames/agones/pull/3873)
- featuregate: adds validation if PortPolicyNone is not enabled by
[@&#8203;daniellee](https://togithub.com/daniellee) in
[https://github.com/googleforgames/agones/pull/3871](https://togithub.com/googleforgames/agones/pull/3871)
- added local as default for registry when registry is not specified by
[@&#8203;kamaljeeti](https://togithub.com/kamaljeeti) in
[https://github.com/googleforgames/agones/pull/3876](https://togithub.com/googleforgames/agones/pull/3876)
- Buffer Unity SDK ReceiveData when watching for configuration changes
by [@&#8203;ZeroParticle](https://togithub.com/ZeroParticle) in
[https://github.com/googleforgames/agones/pull/3872](https://togithub.com/googleforgames/agones/pull/3872)
- agones-{extensions,allocator}: Make servers context aware by
[@&#8203;zmerlynn](https://togithub.com/zmerlynn) in
[https://github.com/googleforgames/agones/pull/3845](https://togithub.com/googleforgames/agones/pull/3845)
- added condition for distributed logic by
[@&#8203;ashutosji](https://togithub.com/ashutosji) in
[https://github.com/googleforgames/agones/pull/3877](https://togithub.com/googleforgames/agones/pull/3877)

**Security fixes:**

- Bump [@&#8203;grpc/grpc-js](https://togithub.com/grpc/grpc-js) from
1.10.7 to 1.10.9 in /sdks/nodejs by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/googleforgames/agones/pull/3863](https://togithub.com/googleforgames/agones/pull/3863)

**Other:**

- Preparation for Release v1.42.0 by
[@&#8203;ashutosji](https://togithub.com/ashutosji) in
[https://github.com/googleforgames/agones/pull/3854](https://togithub.com/googleforgames/agones/pull/3854)
- Add helpful note to edit-first-gameserver-go by
[@&#8203;peterzhongyi](https://togithub.com/peterzhongyi) in
[https://github.com/googleforgames/agones/pull/3846](https://togithub.com/googleforgames/agones/pull/3846)
- Moved Passthrough feature description to the correct section in
Feature Stages by [@&#8203;vicentefb](https://togithub.com/vicentefb) in
[https://github.com/googleforgames/agones/pull/3861](https://togithub.com/googleforgames/agones/pull/3861)
- Updated Node.js Page to Reflect that Counters and Lists is Implemented
by [@&#8203;ashutosji](https://togithub.com/ashutosji) in
[https://github.com/googleforgames/agones/pull/3865](https://togithub.com/googleforgames/agones/pull/3865)
- Change Slack channel description from #developers to #development by
[@&#8203;branhoff](https://togithub.com/branhoff) in
[https://github.com/googleforgames/agones/pull/3868](https://togithub.com/googleforgames/agones/pull/3868)
- updated UpdateList documentation for local sdk server and sdk server
by [@&#8203;ashutosji](https://togithub.com/ashutosji) in
[https://github.com/googleforgames/agones/pull/3878](https://togithub.com/googleforgames/agones/pull/3878)
- Add zio-agones to the list of third party client SDKs by
[@&#8203;ghostdogpr](https://togithub.com/ghostdogpr) in
[https://github.com/googleforgames/agones/pull/3875](https://togithub.com/googleforgames/agones/pull/3875)
- refactor simple game server by
[@&#8203;ashutosji](https://togithub.com/ashutosji) in
[https://github.com/googleforgames/agones/pull/3817](https://togithub.com/googleforgames/agones/pull/3817)
- Update Slack invite link by
[@&#8203;markmandel](https://togithub.com/markmandel) in
[https://github.com/googleforgames/agones/pull/3896](https://togithub.com/googleforgames/agones/pull/3896)
- Added cleanup for app-engine services in cloudbuild script by
[@&#8203;kamaljeeti](https://togithub.com/kamaljeeti) in
[https://github.com/googleforgames/agones/pull/3890](https://togithub.com/googleforgames/agones/pull/3890)
- Adds a command to generate the zz_generated.deepcopy.go files for the
apis by [@&#8203;igooch](https://togithub.com/igooch) in
[https://github.com/googleforgames/agones/pull/3900](https://togithub.com/googleforgames/agones/pull/3900)
- update go version to 1.21.12 by
[@&#8203;ashutosji](https://togithub.com/ashutosji) in
[https://github.com/googleforgames/agones/pull/3894](https://togithub.com/googleforgames/agones/pull/3894)

**New Contributors:**

- [@&#8203;KAllan357](https://togithub.com/KAllan357) made their first
contribution in
[https://github.com/googleforgames/agones/pull/3858](https://togithub.com/googleforgames/agones/pull/3858)
- [@&#8203;branhoff](https://togithub.com/branhoff) made their first
contribution in
[https://github.com/googleforgames/agones/pull/3868](https://togithub.com/googleforgames/agones/pull/3868)
- [@&#8203;aallbrig](https://togithub.com/aallbrig) made their first
contribution in
[https://github.com/googleforgames/agones/pull/3866](https://togithub.com/googleforgames/agones/pull/3866)
- [@&#8203;ZeroParticle](https://togithub.com/ZeroParticle) made their
first contribution in
[https://github.com/googleforgames/agones/pull/3872](https://togithub.com/googleforgames/agones/pull/3872)
- [@&#8203;ghostdogpr](https://togithub.com/ghostdogpr) made their first
contribution in
[https://github.com/googleforgames/agones/pull/3875](https://togithub.com/googleforgames/agones/pull/3875)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzIuMCIsInVwZGF0ZWRJblZlciI6IjM3LjQzMi4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJyZW5vdmF0ZS9oZWxtIiwidHlwZS9taW5vciJdfQ==-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/breaking Breaking change kind/documentation Documentation for Agones size/S size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants