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
16 changes: 16 additions & 0 deletions pkg/util/runtime/features.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,22 @@ 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->beta for SDK Functions
// * Move Files from alpha->beta:
Kalaiselvi84 marked this conversation as resolved.
Show resolved Hide resolved
// - From proto/sdk/alpha/alpha.proto to proto/sdk/beta/beta.proto
// - For each language-specific SDK (e.g., Go, C#, Rust):
// - Move implementation files (e.g., alpha.go to beta.go)
// - Move test files (e.g., alpha_test.go to beta_test.go)
// - Note: Delete references to 'alpha' in the moved alpha files.
Kalaiselvi84 marked this conversation as resolved.
Show resolved Hide resolved
Kalaiselvi84 marked this conversation as resolved.
Show resolved Hide resolved
// * Change all instances of alpha->beta:
Kalaiselvi84 marked this conversation as resolved.
Show resolved Hide resolved
// - Proto Files: proto/sdk/sdk.proto
Kalaiselvi84 marked this conversation as resolved.
Show resolved Hide resolved
// - SDK Implementations: Update in language-specific SDKs (e.g., sdks/go/sdk.go, sdks/csharp/sdk/AgonesSDK.cs).
Kalaiselvi84 marked this conversation as resolved.
Show resolved Hide resolved
// - Examples & Tests: Adjust in files like examples/simple-game-server/main.go and language-specific test files.
// * Include beta information in relevant SDK files
Kalaiselvi84 marked this conversation as resolved.
Show resolved Hide resolved
// * Modify automation scripts in the build/build-sdk-images directory to support beta file generation.
// * Run `make gen-all-sdk-grpc` to generate the required files, then execute the `make run-sdk-conformance-test-go` command and address any issues that arise.
// * 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