Update Rust document #3336

Kalaiselvi84 · 2023-08-21T23:02:46Z

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup

/kind documentation

/kind feature
/kind hotfix
/kind release

What this PR does / Why we need it:

Which issue(s) this PR fixes:

Closes #1932

Special notes for your reviewer:

agones-bot · 2023-08-21T23:37:27Z

Build Failed 😱

Build Id: add8c93f-9ead-4e21-9c7f-a8a22499923d

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

markmandel · 2023-08-21T23:42:23Z

site/content/en/docs/Guides/Client SDKs/rust.md

 ## Prerequisites

 - [Rust >= 1.50](https://www.rust-lang.org/tools/install)

 ## Usage

-Add this crate to `dependencies` section in your Cargo.toml. Specify a directory where this README.md is located to the `path`.
+Add [`this crate`](https://crates.io/crates/agones) to `dependencies` section in your Cargo.toml. 


Suggested change

Add [`this crate`](https://crates.io/crates/agones) to `dependencies` section in your Cargo.toml.

Add <a href="https://crates.io/crates/agones" data-proofer-ignore>this crate</a> to `dependencies` section in your Cargo.toml.

100% seen below before - crates.io hates people scraping them.

======================================================================== site/docs/guides/client-sdks/rust/index.html Non-OK status: 404 --- site/docs/guides/client-sdks/rust/index.html --> https://crates.io/crates/agones

followed your input👍🏻

markmandel · 2023-08-21T23:47:54Z

docs/governance/templates/release_issue.md

@@ -63,7 +63,7 @@ and copy it into a release issue. Fill in relevant values, found inside {}
 - [ ] Post to the [agonesdev](https://twitter.com/agonesdev) Twitter account.
 - [ ] Run `git checkout main`.
 - [ ] Run `make sdk-update-version release_stage=after version={version}` file. This command will update the version number in the sdks/install files to {version}+1-dev.
- [ ] Update the `agones` crate version in `sdks/rust/Cargo.toml` to {version}, then run `cargo publish --dry-run` and, if successful, proceed with `cargo publish`
+- [ ] Update the `agones` crate version in `sdks/rust/Cargo.toml` to {version}. First, run `cargo login` to authenticate with `crates.io`. Afterward, execute `cargo publish --dry-run`. If that is successful, proceed with `cargo publish`.


Optional:

agones/build/includes/sdk.mk

Lines 201 to 217 in 97057bf

sdk-shell:

$(MAKE) ensure-build-sdk-image SDK_FOLDER=$(SDK_FOLDER)

docker run --rm -it $(common_mounts) -v ~/.ssh:/tmp/.ssh:ro $(DOCKER_RUN_ARGS) \

--entrypoint=/root/shell.sh $(SDK_IMAGE_TAG)

# SDK shell for node

sdk-shell-node:

$(MAKE) sdk-shell SDK_FOLDER=node

# SDK shell for csharp

sdk-shell-csharp:

$(MAKE) sdk-shell SDK_FOLDER=csharp

# Publish csharp SDK to NuGet

sdk-publish-csharp: RELEASE_VERSION ?= $(base_version)

sdk-publish-csharp:

$(MAKE) run-sdk-command-csharp COMMAND=publish VERSION=$(RELEASE_VERSION) DOCKER_RUN_ARGS="$(DOCKER_RUN_ARGS) -it"

Could also make a make sdk-shell-rust target and use that command line to do the publishing of the Rust crate (rather than install tools locally).

Not sure if that's how you are doing the node deployments?

Added sdk-shell-rust target but how can we test it? If we execute this target, will it be added in the Agones crate again?

…ones into update-rust-file

agones-bot · 2023-08-22T00:37:41Z

Build Failed 😱

Build Id: 6adbb760-0532-4b5d-88ec-ef8837cdbb4c

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

agones-bot · 2023-08-22T00:41:27Z

Build Failed 😱

Build Id: 0490c059-0db4-4eaa-9cba-fab030a8e066

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

agones-bot · 2023-08-22T02:05:16Z

Build Succeeded 👏

Build Id: 56667775-3c09-43ed-969d-e0c37c12c7ce

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):

https://5b9521c-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3336/head:pr_3336 && git checkout pr_3336
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.35.0-dev-5b9521c-amd64

build/includes/sdk.mk

agones-bot · 2023-08-23T22:44:31Z

Build Failed 😱

Build Id: f2b45224-1d77-4eba-b811-439dbef87f47

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

agones-bot · 2023-08-24T00:13:13Z

Build Succeeded 👏

Build Id: 98b04a0c-7be4-49f8-b9db-10f87995cae6

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):

https://c3e2c99-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3336/head:pr_3336 && git checkout pr_3336
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.35.0-dev-c3e2c99-amd64

markmandel

Love it. Couple of small nits, but otherwise this is good to go.

markmandel · 2023-08-24T21:33:29Z

build/build-sdk-images/rust/publish-rust.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+# Copyright 2020 Google LLC All Rights Reserved.


Nit:

Suggested change

# Copyright 2020 Google LLC All Rights Reserved.

# Copyright 2023 Google LLC All Rights Reserved.

markmandel · 2023-08-24T21:33:54Z

build/build-sdk-images/rust/publish-rust.sh

To be consistent, let's call it publish.sh

markmandel · 2023-08-24T21:34:24Z

build/includes/sdk.mk

+
+# Publish the Rust SDK to crates.io
+sdk-publish-rust:
+	$(MAKE) run-sdk-command-rust VERSION=$(RELEASE_VERSION) DOCKER_RUN_ARGS="$(DOCKER_RUN_ARGS) -it" COMMAND=./publish-rust


Nit (and see comment above for naming):

Suggested change

$(MAKE) run-sdk-command-rust VERSION=$(RELEASE_VERSION) DOCKER_RUN_ARGS="$(DOCKER_RUN_ARGS) -it" COMMAND=./publish-rust

$(MAKE) run-sdk-command-rust VERSION=$(RELEASE_VERSION) DOCKER_RUN_ARGS="$(DOCKER_RUN_ARGS) -it" COMMAND=publish

markmandel · 2023-08-24T21:49:23Z

This okay to me moved to ready for review ?

markmandel

Aaah! Conflict 😄 but good to go when it's fixed.

google-oss-prow · 2023-08-24T22:44:42Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Kalaiselvi84, markmandel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [markmandel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

…ones into update-rust-file

google-oss-prow · 2023-08-24T22:56:13Z

New changes are detected. LGTM label has been removed.

agones-bot · 2023-08-25T02:03:34Z

Build Failed 😱

Build Id: d965ada1-7636-4076-8565-2d44385ed420

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

agones-bot · 2023-08-25T22:58:36Z

Build Succeeded 👏

Build Id: 1abcde39-f0ab-4197-a114-795c6f391875

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):

https://c23eaeb-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3336/head:pr_3336 && git checkout pr_3336
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.35.0-dev-c23eaeb-amd64

…ones into update-rust-file

agones-bot · 2023-08-26T00:08:12Z

Build Succeeded 👏

Build Id: 18baccaa-4d3f-478f-978f-fec213c03bda

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):

https://129599f-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3336/head:pr_3336 && git checkout pr_3336
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.35.0-dev-129599f-amd64

Update Rust document

9f1ea76

Kalaiselvi84 requested a review from markmandel August 21, 2023 23:02

google-oss-prow bot requested review from cyriltovena and EricFortin August 21, 2023 23:02

google-oss-prow bot added the size/S label Aug 21, 2023

github-actions bot added the kind/documentation Documentation for Agones label Aug 21, 2023

Merge branch 'main' into update-rust-file

b391c62

markmandel reviewed Aug 21, 2023

View reviewed changes

Kalaiselvi84 added 3 commits August 22, 2023 00:25

sdk-shell-rust target

af1c536

help me git command

ace56aa

Merge branch 'update-rust-file' of https://github.com/Kalaiselvi84/ag…

0b218c5

…ones into update-rust-file

modify crate link

d52476e

tab issue

5b9521c

markmandel reviewed Aug 22, 2023

View reviewed changes

build/includes/sdk.mk Show resolved Hide resolved

Kalaiselvi84 marked this pull request as draft August 22, 2023 21:05

google-oss-prow bot added the do-not-merge/work-in-progress label Aug 22, 2023

publish rust sdk with sh file

7ab9a5c

google-oss-prow bot added size/M and removed size/S labels Aug 22, 2023

Kalaiselvi84 added 3 commits August 22, 2023 22:04

sdk-publish-rust target works

d00f07b

uncomment cargo publish

ab73934

Merge branch 'main' into update-rust-file

84f2f30

Kalaiselvi84 marked this pull request as ready for review August 22, 2023 22:20

google-oss-prow bot removed the do-not-merge/work-in-progress label Aug 22, 2023

google-oss-prow bot requested a review from aLekSer August 22, 2023 22:20

Resolve lint issue

c3e2c99

markmandel reviewed Aug 24, 2023

View reviewed changes

suggested changes

04be4c7

Kalaiselvi84 marked this pull request as ready for review August 24, 2023 21:53

google-oss-prow bot removed the do-not-merge/work-in-progress label Aug 24, 2023

google-oss-prow bot requested a review from roberthbailey August 24, 2023 21:53

Merge branch 'main' into update-rust-file

ae46ff5

markmandel approved these changes Aug 24, 2023

View reviewed changes

google-oss-prow bot assigned markmandel Aug 24, 2023

google-oss-prow bot added the lgtm label Aug 24, 2023

google-oss-prow bot added the approved label Aug 24, 2023

Kalaiselvi84 added 3 commits August 24, 2023 22:49

Merge branch 'main' into update-rust-file

b5a71ed

resolve conflict

ae62538

Merge branch 'update-rust-file' of https://github.com/Kalaiselvi84/ag…

d370583

…ones into update-rust-file

google-oss-prow bot removed the lgtm label Aug 24, 2023

markmandel enabled auto-merge (squash) August 24, 2023 23:05

Merge branch 'main' into update-rust-file

0d7e274

Merge branch 'main' into update-rust-file

c23eaeb

Kalaiselvi84 added 2 commits August 25, 2023 23:02

resolve conflict

053eb5b

Merge branch 'update-rust-file' of https://github.com/Kalaiselvi84/ag…

129599f

…ones into update-rust-file

markmandel merged commit 176431c into googleforgames:main Aug 26, 2023
2 of 3 checks passed

Kalaiselvi84 deleted the update-rust-file branch March 15, 2024 01:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Rust document #3336

Update Rust document #3336

Kalaiselvi84 commented Aug 21, 2023 •

edited

agones-bot commented Aug 21, 2023

markmandel Aug 21, 2023

Kalaiselvi84 Aug 22, 2023

markmandel Aug 21, 2023

Kalaiselvi84 Aug 22, 2023

agones-bot commented Aug 22, 2023

agones-bot commented Aug 22, 2023

agones-bot commented Aug 22, 2023

agones-bot commented Aug 23, 2023

agones-bot commented Aug 24, 2023

markmandel left a comment

markmandel Aug 24, 2023

Kalaiselvi84 Aug 24, 2023

markmandel Aug 24, 2023

Kalaiselvi84 Aug 24, 2023

markmandel Aug 24, 2023

Kalaiselvi84 Aug 24, 2023

markmandel commented Aug 24, 2023

markmandel left a comment

google-oss-prow bot commented Aug 24, 2023

google-oss-prow bot commented Aug 24, 2023

agones-bot commented Aug 25, 2023

agones-bot commented Aug 25, 2023

agones-bot commented Aug 26, 2023

	Add [`this crate`](https://crates.io/crates/agones) to `dependencies` section in your Cargo.toml.
	Add <a href="https://crates.io/crates/agones" data-proofer-ignore>this crate</a> to `dependencies` section in your Cargo.toml.

	sdk-shell:
	$(MAKE) ensure-build-sdk-image SDK_FOLDER=$(SDK_FOLDER)
	docker run --rm -it $(common_mounts) -v ~/.ssh:/tmp/.ssh:ro $(DOCKER_RUN_ARGS) \
	--entrypoint=/root/shell.sh $(SDK_IMAGE_TAG)

	# SDK shell for node
	sdk-shell-node:
	$(MAKE) sdk-shell SDK_FOLDER=node

	# SDK shell for csharp
	sdk-shell-csharp:
	$(MAKE) sdk-shell SDK_FOLDER=csharp

	# Publish csharp SDK to NuGet
	sdk-publish-csharp: RELEASE_VERSION ?= $(base_version)
	sdk-publish-csharp:
	$(MAKE) run-sdk-command-csharp COMMAND=publish VERSION=$(RELEASE_VERSION) DOCKER_RUN_ARGS="$(DOCKER_RUN_ARGS) -it"

		@@ -0,0 +1,35 @@
		#!/usr/bin/env bash

		# Copyright 2020 Google LLC All Rights Reserved.

	# Copyright 2020 Google LLC All Rights Reserved.
	# Copyright 2023 Google LLC All Rights Reserved.

	$(MAKE) run-sdk-command-rust VERSION=$(RELEASE_VERSION) DOCKER_RUN_ARGS="$(DOCKER_RUN_ARGS) -it" COMMAND=./publish-rust
	$(MAKE) run-sdk-command-rust VERSION=$(RELEASE_VERSION) DOCKER_RUN_ARGS="$(DOCKER_RUN_ARGS) -it" COMMAND=publish

Update Rust document #3336

Update Rust document #3336

Conversation

Kalaiselvi84 commented Aug 21, 2023 • edited

agones-bot commented Aug 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Aug 22, 2023

agones-bot commented Aug 22, 2023

agones-bot commented Aug 22, 2023

agones-bot commented Aug 23, 2023

agones-bot commented Aug 24, 2023

markmandel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markmandel commented Aug 24, 2023

markmandel left a comment

Choose a reason for hiding this comment

google-oss-prow bot commented Aug 24, 2023

google-oss-prow bot commented Aug 24, 2023

agones-bot commented Aug 25, 2023

agones-bot commented Aug 25, 2023

agones-bot commented Aug 26, 2023

Kalaiselvi84 commented Aug 21, 2023 •

edited