Skip to content
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
46 changes: 0 additions & 46 deletions .github/workflows/go.yaml

This file was deleted.

36 changes: 4 additions & 32 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,17 @@ Assisted-by: GLM 4.6 via Claude Code

- Include a clear description of changes
- Reference any related issues
- Pass CI (`npm test` for JavaScript, `go test` for Go)
- Pass CI (`npm test` for JavaScript)
- Optionally add screenshots for UI changes

### Security Best Practices

- Secrets never belong in the repo; use environment variables or the `secrets` directory (ignored by Git)
- Run `npm audit` periodically for JavaScript packages and address reported vulnerabilities
- For Go, use `go mod` to manage dependencies and keep them updated

## Project Structure

This is a monorepo for Tigris object storage SDKs and CLI, containing:
This is a monorepo for Tigris object storage SDKs, containing:

### JavaScript/TypeScript Packages

Expand All @@ -72,23 +71,6 @@ Root-level npm scripts:
- `npm run format` - Format all packages with Prettier
- `npm run clean` - Clean build artifacts

### Go SDK

Located in the [`go/`](go/) directory:

- **Module**: `github.com/tigrisdata/storage`
- **Go version**: 1.25.5
- **Uses**: AWS SDK v2 for Go
- **Main files**:
- `client.go` - Client implementation
- `storage.go` - Storage operations
- `tigrisheaders/` - Tigris-specific headers

Go commands:
- `go test ./go/...` - Run all Go tests
- `go build ./go/...` - Build all Go packages
- `go mod tidy` - Clean up dependencies

## Development Workflow

### JavaScript/TypeScript Development
Expand All @@ -99,18 +81,9 @@ Go commands:
4. Format code: `npm run format`
5. Lint code: `npm run lint`

### Go Development

1. Navigate to Go directory: `cd go`
2. Run tests: `go test ./...`
3. Build: `go build ./...`
4. Format code: `go fmt ./...`
5. Manage dependencies: `go mod tidy`

## Testing

- **JavaScript**: Uses Vitest as the test runner
- **Go**: Uses the standard `go test` command
- Always run tests before committing changes
- Ensure all tests pass in CI before merging

Expand All @@ -119,11 +92,10 @@ Go commands:
- Releases are automated using semantic-release
- Commits to `main` trigger automatic releases
- Pre-releases are done on the `next` branch
- Both JavaScript packages and Go SDK follow semantic versioning
- JavaScript packages follow semantic versioning

## Additional Notes

- The project uses Husky for Git hooks (commitlint, etc.)
- Commitizen is configured for conventional commits
- ESLint and Prettier are used for JavaScript/TypeScript code quality
- Go code should follow standard Go conventions and use `go fmt`
- ESLint and Prettier are used for JavaScript/TypeScript code quality
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# Tigris Storage SDK
# Tigris Storage SDKs

Tigris is a globally distributed object storage service that provides low latency anywhere in the world, enabling developers to store and access any amount of data for a wide range of use cases.

This monorepo contains multiple packages for Tigris object storage:
## JavaScript/TypeScript SDK

This monorepo contains multiple JavaScript/TypeScript packages for Tigris object storage:

- [`@tigrisdata/storage`](./packages/storage) - Tigris Storage SDK
- [`@tigrisdata/keyv-tigris`](./packages/keyv-tigris) - Tigris adapter for [Keyv](https://keyv.org/)
- [`@tigrisdata/react`](./packages/react) - Ready to use React Components and Hooks

## Go SDK

For more information about the Go SDK, see the [Go SDK README](./go/README.md).
The Go SDK is maintained in a separate repository:

- Repository: [https://github.com/tigrisdata/storage-go](https://github.com/tigrisdata/storage-go)
- Documentation: [https://pkg.go.dev/github.com/tigrisdata/storage-go](https://pkg.go.dev/github.com/tigrisdata/storage-go)

Install with:

```sh
go get github.com/tigrisdata/storage-go
```

See the documentation for examples and quickstart advice.
28 changes: 0 additions & 28 deletions go.mod

This file was deleted.

38 changes: 0 additions & 38 deletions go.sum

This file was deleted.

Loading