Skip to content

Commit

Permalink
docs: add release guidance (#691)
Browse files Browse the repository at this point in the history
* docs: add release guidance

* address feedback
  • Loading branch information
frankyn authored Oct 17, 2024
1 parent fe4e49c commit 6efd38f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ is expected to be used by Storage library maintainers.
- [Delete a Retry Test resource](#delete-a-retry-test-resource)
- [Causing a failure using x-retry-test-id header](#causing-a-failure-using-x-retry-test-id-header)
- [Forced Failures Supported](#forced-failures-supported)
- [Releasing the testbench](#releasing-the-testbench)

## Issue Policy

Expand Down Expand Up @@ -252,3 +253,15 @@ curl -H "x-retry-test-id: 1d05c20627844214a9ff7cbcf696317d" "http://localhost:91
| return-broken-stream-after-YK | [HTTP] Testbench will fail after YKiB of downloaded data <br> [GRPC] Testbench will fail with `UNAVAILABLE` after YKiB of downloaded data
| return-reset-connection | [HTTP] Testbench will fail with a reset connection <br> [GRPC] Testbench will fail the RPC with `UNAVAILABLE`
| stall-for-Ts-after-YK | [HTTP] Testbench will stall for T second after reading YKiB of downloaded data, e.g. stall-for-10s-after-12K stalls after reading 12KiB of data <br> [GRPC] Not supported

## Releasing the testbench

The repository currently uses [Github Tags](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)

Steps:
1. Go to https://github.com/googleapis/storage-testbench/releases/new
1. Create a new tag v0.x.x
1. Title "v0.x.x"
1. Click Generate release notes
1. Make sure "Set as the latest release" is checked
1. Click "Publish Release" to release

0 comments on commit 6efd38f

Please sign in to comment.