Skip to content

Commit

Permalink
Steps to Promote SDK Features from Alpha to Beta (#3814)
Browse files Browse the repository at this point in the history
* Steps to Promote SDK Features from Alpha to Beta

* make more generic

* modify steps

* Review changes

* review change
  • Loading branch information
Kalaiselvi84 authored May 15, 2024
1 parent 00b8fb1 commit 7d168a4
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions pkg/util/runtime/features.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,21 @@ 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 methods from alpha->beta files:
// - 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 methods.
// * Change all code and documentation references of alpha->beta:
// - Proto Files: proto/sdk/sdk.proto `[Stage:Alpha]->[Stage:Beta]`
// - SDK Implementations: Update in language-specific SDKs (e.g., sdks/go/sdk.go, sdks/csharp/sdk/AgonesSDK.cs).
// - Examples & Tests: Adjust in files like examples/simple-game-server/main.go and language-specific test files.
// * 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

0 comments on commit 7d168a4

Please sign in to comment.