Skip to content

Commit dbcc2a8

Browse files
committed
Update docs, reference pkg.go.dev
1 parent ceadf4f commit dbcc2a8

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
3535
- name: Install dependencies
3636
run: |
37-
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.33.0
37+
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.35.2
3838
export REPOSITORY_ROOT=${GITHUB_WORKSPACE}
3939
4040
- name: Run test suite

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# sarama
22

3-
[![GoDoc](https://godoc.org/github.com/Shopify/sarama?status.svg)](https://pkg.go.dev/github.com/Shopify/sarama)
3+
[![Go Reference](https://pkg.go.dev/badge/github.com/Shopify/sarama.svg)](https://pkg.go.dev/github.com/Shopify/sarama)
44
[![Build Status](https://travis-ci.org/Shopify/sarama.svg?branch=master)](https://travis-ci.org/Shopify/sarama)
55
[![Coverage](https://codecov.io/gh/Shopify/sarama/branch/master/graph/badge.svg)](https://codecov.io/gh/Shopify/sarama)
66

77
Sarama is an MIT-licensed Go client library for [Apache Kafka](https://kafka.apache.org/) version 0.8 (and later).
88

99
## Getting started
1010

11-
- API documentation and examples are available via [godoc](https://godoc.org/github.com/Shopify/sarama).
11+
- API documentation and examples are available via [pkg.go.dev](https://pkg.go.dev/github.com/Shopify/sarama).
1212
- Mocks for testing are available in the [mocks](./mocks) subpackage.
1313
- The [examples](./examples) directory contains more elaborate example applications.
1414
- The [tools](./tools) directory contains command line tools that can be useful for testing, diagnostics, and instrumentation.
@@ -20,7 +20,7 @@ You might also want to look at the [Frequently Asked Questions](https://github.c
2020
Sarama provides a "2 releases + 2 months" compatibility guarantee: we support
2121
the two latest stable releases of Kafka and Go, and we provide a two month
2222
grace period for older releases. This means we currently officially support
23-
Go 1.13 through 1.14, and Kafka 2.4 through 2.6, although older releases are
23+
Go 1.14 through 1.15, and Kafka 2.5 through 2.7, although older releases are
2424
still likely to work.
2525

2626
Sarama follows semantic versioning and provides API stability via the gopkg.in service.

examples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Sarama examples
22

3-
This folder contains example applications to demonstrate the use of Sarama. For code snippet examples on how to use the different types in Sarama, see [Sarama's API documentation on godoc.org](https://godoc.org/github.com/Shopify/sarama)
3+
This folder contains example applications to demonstrate the use of Sarama. For code snippet examples on how to use the different types in Sarama, see [Sarama's API documentation on pkg.go.dev](https://pkg.go.dev/github.com/Shopify/sarama)
44

55
In these examples, we use `github.com/Shopify/sarama` as import path. We do this to ensure all the examples are up to date with the latest changes in Sarama. For your own applications, you may want to use `gopkg.in/Shopify/sarama.v1` to lock into a stable API version.
66

77
#### HTTP server
88

9-
[http_server](./http_server) is a simple HTTP server uses both the sync producer to produce data as part of the request handling cycle, as well as the async producer to maintain an access log. It also uses the [mocks subpackage](https://godoc.org/github.com/Shopify/sarama/mocks) to test both.
9+
[http_server](./http_server) is a simple HTTP server uses both the sync producer to produce data as part of the request handling cycle, as well as the async producer to maintain an access log. It also uses the [mocks subpackage](https://pkg.go.dev/github.com/Shopify/sarama/mocks) to test both.
1010

1111
#### Interceptors
1212

mocks/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ You can use them to test your sarama applications using dependency injection.
55

66
The following mock objects are available:
77

8-
- [Consumer](https://godoc.org/github.com/Shopify/sarama/mocks#Consumer), which will create [PartitionConsumer](https://godoc.org/github.com/Shopify/sarama/mocks#PartitionConsumer) mocks.
9-
- [AsyncProducer](https://godoc.org/github.com/Shopify/sarama/mocks#AsyncProducer)
10-
- [SyncProducer](https://godoc.org/github.com/Shopify/sarama/mocks#SyncProducer)
8+
- [Consumer](https://pkg.go.dev/github.com/Shopify/sarama/mocks#Consumer), which will create [PartitionConsumer](https://pkg.go.dev/github.com/Shopify/sarama/mocks#PartitionConsumer) mocks.
9+
- [AsyncProducer](https://pkg.go.dev/github.com/Shopify/sarama/mocks#AsyncProducer)
10+
- [SyncProducer](https://pkg.go.dev/github.com/Shopify/sarama/mocks#SyncProducer)
1111

1212
The mocks allow you to set expectations on them. When you close the mocks, the expectations will be verified,
1313
and the results will be reported to the `*testing.T` object you provided when creating the mock.

0 commit comments

Comments
 (0)