-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e29a27e
commit b6fc2c3
Showing
25 changed files
with
172 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| name: Release Doctor | ||
| on: | ||
| pull_request: | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| release_doctor: | ||
| name: release doctor | ||
| runs-on: ubuntu-latest | ||
| if: github.repository == 'terminaldotshop/terminal-sdk-go' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Check release environment | ||
| run: | | ||
| bash ./scripts/check-release-environment |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| ".": "0.0.1-alpha.0" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Terminal Go API Library | ||
|
|
||
| <a href="https://pkg.go.dev/github.com/stainless-sdks/terminal-go"><img src="https://pkg.go.dev/badge/github.com/stainless-sdks/terminal-go.svg" alt="Go Reference"></a> | ||
| <a href="https://pkg.go.dev/github.com/terminaldotshop/terminal-sdk-go"><img src="https://pkg.go.dev/badge/github.com/terminaldotshop/terminal-sdk-go.svg" alt="Go Reference"></a> | ||
|
|
||
| The Terminal Go library provides convenient access to [the Terminal REST | ||
| API](https://docs.terminal.com) from applications written in Go. The full API of this library can be found in [api.md](api.md). | ||
|
|
@@ -9,18 +9,26 @@ It is generated with [Stainless](https://www.stainlessapi.com/). | |
|
|
||
| ## Installation | ||
|
|
||
| <!-- x-release-please-start-version --> | ||
|
|
||
| ```go | ||
| import ( | ||
| "github.com/stainless-sdks/terminal-go" // imported as terminal | ||
| "github.com/terminaldotshop/terminal-sdk-go" // imported as terminal | ||
| ) | ||
| ``` | ||
|
|
||
| <!-- x-release-please-end --> | ||
|
|
||
| Or to pin the version: | ||
|
|
||
| <!-- x-release-please-start-version --> | ||
|
|
||
| ```sh | ||
| go get -u 'github.com/stainless-sdks/[email protected]' | ||
| go get -u 'github.com/terminaldotshop/terminal-sdk[email protected]' | ||
| ``` | ||
|
|
||
| <!-- x-release-please-end --> | ||
|
|
||
| ## Requirements | ||
|
|
||
| This library requires Go 1.18+. | ||
|
|
@@ -36,8 +44,8 @@ import ( | |
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/stainless-sdks/terminal-go" | ||
| "github.com/stainless-sdks/terminal-go/option" | ||
| "github.com/terminaldotshop/terminal-sdk-go" | ||
| "github.com/terminaldotshop/terminal-sdk-go/option" | ||
| ) | ||
|
|
||
| func main() { | ||
|
|
@@ -146,7 +154,7 @@ client.Product.Get(context.TODO(), ..., | |
| ) | ||
| ``` | ||
|
|
||
| See the [full list of request options](https://pkg.go.dev/github.com/stainless-sdks/terminal-go/option). | ||
| See the [full list of request options](https://pkg.go.dev/github.com/terminaldotshop/terminal-sdk-go/option). | ||
|
|
||
| ### Pagination | ||
|
|
||
|
|
@@ -325,4 +333,4 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con | |
|
|
||
| We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience. | ||
|
|
||
| We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/terminal-go/issues) with questions, bugs, or suggestions. | ||
| We are keen for your feedback; please open an [issue](https://www.github.com/terminaldotshop/terminal-sdk-go/issues) with questions, bugs, or suggestions. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| module github.com/stainless-sdks/terminal-go | ||
| module github.com/terminaldotshop/terminal-sdk-go | ||
|
|
||
| go 1.19 | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| { | ||
| "packages": { | ||
| ".": {} | ||
| }, | ||
| "$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json", | ||
| "include-v-in-tag": true, | ||
| "include-component-in-tag": false, | ||
| "versioning": "prerelease", | ||
| "prerelease": true, | ||
| "bump-minor-pre-major": true, | ||
| "bump-patch-for-minor-pre-major": false, | ||
| "pull-request-header": "Automated Release PR", | ||
| "pull-request-title-pattern": "release: ${version}", | ||
| "changelog-sections": [ | ||
| { | ||
| "type": "feat", | ||
| "section": "Features" | ||
| }, | ||
| { | ||
| "type": "fix", | ||
| "section": "Bug Fixes" | ||
| }, | ||
| { | ||
| "type": "perf", | ||
| "section": "Performance Improvements" | ||
| }, | ||
| { | ||
| "type": "revert", | ||
| "section": "Reverts" | ||
| }, | ||
| { | ||
| "type": "chore", | ||
| "section": "Chores" | ||
| }, | ||
| { | ||
| "type": "docs", | ||
| "section": "Documentation" | ||
| }, | ||
| { | ||
| "type": "style", | ||
| "section": "Styles" | ||
| }, | ||
| { | ||
| "type": "refactor", | ||
| "section": "Refactors" | ||
| }, | ||
| { | ||
| "type": "test", | ||
| "section": "Tests", | ||
| "hidden": true | ||
| }, | ||
| { | ||
| "type": "build", | ||
| "section": "Build System" | ||
| }, | ||
| { | ||
| "type": "ci", | ||
| "section": "Continuous Integration", | ||
| "hidden": true | ||
| } | ||
| ], | ||
| "release-type": "go", | ||
| "extra-files": [ | ||
| "internal/version.go", | ||
| "README.md" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| warnings=() | ||
| errors=() | ||
|
|
||
| lenWarnings=${#warnings[@]} | ||
|
|
||
| if [[ lenWarnings -gt 0 ]]; then | ||
| echo -e "Found the following warnings in the release environment:\n" | ||
|
|
||
| for warning in "${warnings[@]}"; do | ||
| echo -e "- $warning\n" | ||
| done | ||
| fi | ||
|
|
||
| lenErrors=${#errors[@]} | ||
|
|
||
| if [[ lenErrors -gt 0 ]]; then | ||
| echo -e "Found the following errors in the release environment:\n" | ||
|
|
||
| for error in "${errors[@]}"; do | ||
| echo -e "- $error\n" | ||
| done | ||
|
|
||
| exit 1 | ||
| fi | ||
|
|
||
| echo "The environment is ready to push releases!" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.