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

docs: release please update versions on docs automatically #321

Merged
merged 2 commits into from
Mar 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/release-please.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,9 @@ handleGHRelease: true
packageName: genai-toolbox
releaseType: simple
versionFile: "cmd/version.txt"
extraFiles: [
"README.md",
"docs/en/getting-started/introduction/_index.md",
"docs/en/getting-started/local_quickstart.md",
"docs/en/how-to/deploy_gke.md",
]
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ following instructions for your OS and CPU architecture.

To install Toolbox as a binary:

<!-- {x-release-please-start-version} -->
```sh
# see releases page for other versions
export VERSION=0.2.0
Expand Down Expand Up @@ -102,6 +103,7 @@ To install from source, ensure you have the latest version of
```sh
go install github.com/googleapis/genai-toolbox@v0.2.0
```
<!-- {x-release-please-end} -->

</details>

Expand Down
2 changes: 2 additions & 0 deletions docs/en/getting-started/introduction/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ following instructions for your OS and CPU architecture.

[releases]: https://github.com/googleapis/genai-toolbox/releases

<!-- {x-release-please-start-version} -->
{{< tabpane text=true >}}
{{% tab header="Binary" lang="en" %}}

Expand Down Expand Up @@ -77,6 +78,7 @@ go install github.com/googleapis/genai-toolbox@v0.2.0

{{% /tab %}}
{{< /tabpane >}}
<!-- {x-release-please-end} -->

### Running the server

Expand Down
2 changes: 2 additions & 0 deletions docs/en/getting-started/local_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,12 @@ In this section, we will download Toolbox, configure our tools in a
[correct binary](https://github.com/googleapis/genai-toolbox/releases)
corresponding to your OS and CPU architecture.
{{< /notice >}}
<!-- {x-release-please-start-version} -->
```bash
export OS="linux/amd64" # one of linux/amd64, darwin/arm64, darwin/amd64, or windows/amd64
curl -O https://storage.googleapis.com/genai-toolbox/v0.2.0/$OS/toolbox
```
<!-- {x-release-please-end} -->

1. Make the binary executable:

Expand Down
2 changes: 2 additions & 0 deletions docs/en/how-to/deploy_gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ description: >

1. Create a Kubernetes manifest file (`k8s_deployment.yaml`) to build deployment.

<!-- {x-release-please-start-version} -->
```yaml
apiVersion: apps/v1
kind: Deployment
Expand Down Expand Up @@ -189,6 +190,7 @@ description: >
- key: tools.yaml
path: tools.yaml
```
<!-- {x-release-please-end} -->

1. Create the deployment.

Expand Down
Loading