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

Steps to Promote SDK Features from Alpha to Beta #3814

Merged
merged 12 commits into from
May 15, 2024
36 changes: 36 additions & 0 deletions pkg/util/runtime/features.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,42 @@ var (
// * change the value in site/content/en/docs/Guides/feature-stages.md.
// * Ensure that the features in each file are organized categorically and alphabetically.
//
// ** Feature Promotion: Alpha to Beta for SDK Functions
// * Move alpha feature to beta from:
// - proto/sdk/alpha/alpha.proto to proto/sdk/beta/beta.proto.
// - sdks/go/alpha.go to sdks/go/beta.go
// - sdks/go/alpha_test.go to sdks/go/beta_test.go
// - sdks/csharp/proto/sdk/alpha/alpha.proto to sdks/csharp/proto/sdk/beta/beta.proto
// - sdks/csharp/sdk/Alpha.cs to sdks/csharp/sdk/Beta.cs
// - sdks/csharp/sdk/IAgonesAlphaSDK.cs to sdks/csharp/sdk/IAgonesBetaSDK.cs
// - sdks/csharp/test/AgonesAlphaSDKClientTests.cs to sdks/csharp/test/AgonesBetaSDKClientTests.cs
// - sdks/rust/proto/sdk/alpha/alpha.proto to sdks/rust/proto/sdk/beta/beta.proto
// - sdks/swagger/alpha.swagger.json to sdks/swagger/beta.swagger.json
Kalaiselvi84 marked this conversation as resolved.
Show resolved Hide resolved
Kalaiselvi84 marked this conversation as resolved.
Show resolved Hide resolved
// - NOTE: Delete alpha feature related lines from alpha files and update import paths accordingly.
//
// * Change all instances of "alpha" to "beta" in the following files:
// - proto/sdk/sdk.proto
// - examples/simple-game-server/main.go
// - pkg/sdkserver/localsdk.go
// - pkg/sdkserver/localsdk_test.go
// - pkg/sdkserver/sdkserver.go
// - pkg/sdkserver/sdkserver_test.go
// - test/sdk/restapi/http-api-test.go
// - sdks/csharp/proto/sdk/sdk.proto
// - test/sdk/csharp/Program.cs
// - test/sdk/go/sdk-client-test.go
// - sdks/rust/proto/sdk/sdk.proto
// - sdks/swagger/sdk.swagger.json
//
// * Add beta info in:
// - sdks/go/sdk.go
// - cmd/sdk-server/main.go
// - sdks/csharp/sdk/AgonesSDK.cs
// - sdks/csharp/sdk/IAgonesSDK.cs
// * Update build/build-sdk-images/restapi/gen.sh, build/build-sdk-images/csharp/gen.sh to automate beta file generation
// * Run `make gen-all-sdk-grpc` to modify autogenerated files
// * NOTE: DO NOT EDIT any autogenerated code. `make gen-all-sdk-grpc` will take care of it.
//
// To promote a feature from beta->GA:
// * remove all places consuming the feature gate and fold logic to true
// * consider cleanup - often folding a gate to true allows refactoring
Expand Down
Loading