ref: Rename example/ directory to _examples/ (#521)

getsentry · Jan 9, 2023 · e081f7e · e081f7e
1 parent 6588be3
commit e081f7e
Show file tree

Hide file tree

Showing 29 changed files with 14 additions and 17 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -99,7 +99,7 @@ jobs:
         run: |
           # Iris requires Module mode, therefore we delete the relevant code to
           # skip testing it in GOPATH mode.
-          rm -vrf ./iris/ ./example/iris/
+          rm -vrf ./iris/ ./_examples/iris/
       - name: Download Dependencies
         run: go get -d -t -v ./...
       - name: Build

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,10 +18,10 @@ Due to ongoing work towards a stable API for `v1.0.0`, we sadly had to include *
       ```
 - Unify TracesSampler [#498](https://github.com/getsentry/sentry-go/pull/498)
     - `TracesSampler` was changed to a callback that must return a `float64` between `0.0` and `1.0`.
-       
+
        For example, you can apply a sample rate of `1.0` (100%) to all `/api` transactions, and a sample rate of `0.5` (50%) to all other transactions.
        You can read more about this in our [SDK docs](https://docs.sentry.io/platforms/go/configuration/filtering/#using-sampling-to-filter-transaction-events).
-       
+
        ```go
        sentry.Init(sentry.ClientOptions{
            TracesSampler: sentry.TracesSampler(func(ctx sentry.SamplingContext) float64 {
@@ -40,7 +40,7 @@ Due to ongoing work towards a stable API for `v1.0.0`, we sadly had to include *
 ### Features
 
 - Send errors logged with [Logrus](https://github.com/sirupsen/logrus) to Sentry.
-    - Have a look at our [logrus examples](https://github.com/getsentry/sentry-go/blob/master/example/logrus/main.go) on how to use the integration.
+    - Have a look at our [logrus examples](https://github.com/getsentry/sentry-go/blob/master/_examples/logrus/main.go) on how to use the integration.
 - Add support for Dynamic Sampling [#491](https://github.com/getsentry/sentry-go/pull/491)
     - You can read more about Dynamic Sampling in our [product docs](https://docs.sentry.io/product/data-management-settings/dynamic-sampling/).
 - Add detailed logging about the reason transactions are being dropped.
@@ -128,7 +128,7 @@ There are no breaking changes and upgrading should be a smooth experience for al
 _NOTE:_
 This version introduces support for [Sentry's Performance Monitoring](https://docs.sentry.io/platforms/go/performance/).
 The new tracing capabilities are beta, and we plan to expand them on future versions. Feedback is welcome, please open new issues on GitHub.
-The `sentryhttp` package got better API docs, an [updated usage example](https://github.com/getsentry/sentry-go/tree/master/example/http) and support for creating automatic transactions as part of Performance Monitoring.
+The `sentryhttp` package got better API docs, an [updated usage example](https://github.com/getsentry/sentry-go/tree/master/_examples/http) and support for creating automatic transactions as part of Performance Monitoring.
 
 ## v0.8.0
 

diff --git a/example/basic/main.go → _examples/basic/main.go b/example/basic/main.go → _examples/basic/main.go
diff --git a/example/echo/main.go → _examples/echo/main.go b/example/echo/main.go → _examples/echo/main.go
diff --git a/example/fasthttp/main.go → _examples/fasthttp/main.go b/example/fasthttp/main.go → _examples/fasthttp/main.go
diff --git a/example/feature-showcase/main.go → _examples/feature-showcase/main.go b/example/feature-showcase/main.go → _examples/feature-showcase/main.go
diff --git a/example/flush/main.go → _examples/flush/main.go b/example/flush/main.go → _examples/flush/main.go
diff --git a/example/gin/main.go → _examples/gin/main.go b/example/gin/main.go → _examples/gin/main.go
diff --git a/example/http/main.go → _examples/http/main.go b/example/http/main.go → _examples/http/main.go
diff --git a/example/iris/main.go → _examples/iris/main.go b/example/iris/main.go → _examples/iris/main.go
diff --git a/example/logrus/main.go → _examples/logrus/main.go b/example/logrus/main.go → _examples/logrus/main.go
diff --git a/example/martini/main.go → _examples/martini/main.go b/example/martini/main.go → _examples/martini/main.go
diff --git a/example/multiclient/main.go → _examples/multiclient/main.go b/example/multiclient/main.go → _examples/multiclient/main.go
diff --git a/example/negroni/main.go → _examples/negroni/main.go b/example/negroni/main.go → _examples/negroni/main.go
diff --git a/example/recover-repanic/main.go → _examples/recover-repanic/main.go b/example/recover-repanic/main.go → _examples/recover-repanic/main.go
diff --git a/example/recover/main.go → _examples/recover/main.go b/example/recover/main.go → _examples/recover/main.go
diff --git a/example/synctransport/main.go → _examples/synctransport/main.go b/example/synctransport/main.go → _examples/synctransport/main.go
diff --git a/example/with_extra/main.go → _examples/with_extra/main.go b/example/with_extra/main.go → _examples/with_extra/main.go
diff --git a/doc.go b/doc.go
@@ -18,7 +18,7 @@ Sentry project. This step is accomplished through a call to sentry.Init.
 	}
 
 A more detailed yet simple example is available at
-https://github.com/getsentry/sentry-go/blob/master/example/basic/main.go.
+https://github.com/getsentry/sentry-go/blob/master/_examples/basic/main.go.
 
 # Error Reporting
 

diff --git a/echo/README.md b/echo/README.md
@@ -9,7 +9,7 @@
 
 **Godoc:** https://godoc.org/github.com/getsentry/sentry-go/echo
 
-**Example:** https://github.com/getsentry/sentry-go/tree/master/example/echo
+**Example:** https://github.com/getsentry/sentry-go/tree/master/_examples/echo
 
 ## Installation
 

diff --git a/fasthttp/README.md b/fasthttp/README.md
@@ -9,7 +9,7 @@
 
 **Godoc:** https://godoc.org/github.com/getsentry/sentry-go/fasthttp
 
-**Example:** https://github.com/getsentry/sentry-go/tree/master/example/fasthttp
+**Example:** https://github.com/getsentry/sentry-go/tree/master/_examples/fasthttp
 
 ## Installation
 

diff --git a/gin/README.md b/gin/README.md
@@ -9,7 +9,7 @@
 
 **Godoc:** https://godoc.org/github.com/getsentry/sentry-go/gin
 
-**Example:** https://github.com/getsentry/sentry-go/tree/master/example/gin
+**Example:** https://github.com/getsentry/sentry-go/tree/master/_examples/gin
 
 ## Installation
 

diff --git a/go.mod b/go.mod
@@ -34,7 +34,6 @@ require (
 	github.com/go-playground/universal-translator v0.18.0 // indirect
 	github.com/go-playground/validator/v10 v10.11.1 // indirect
 	github.com/goccy/go-json v0.9.11 // indirect
-	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.3.0 // indirect
 	github.com/gorilla/css v1.0.0 // indirect

diff --git a/go.sum b/go.sum
@@ -46,8 +46,6 @@ github.com/go-playground/validator/v10 v10.11.1 h1:prmOlTVv+YjZjmRmNSF3VmspqJIxJ
 github.com/go-playground/validator/v10 v10.11.1/go.mod h1:i+3WkQ1FvaUjjxh1kSvIA4dMGDBiPU55YFDl0WbKdWU=
 github.com/goccy/go-json v0.9.11 h1:/pAaQDLHEoCq/5FFmSKBswWmK6H0e8g4159Kc/X/nqk=
 github.com/goccy/go-json v0.9.11/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
-github.com/golang-jwt/jwt v3.2.2+incompatible h1:IfV12K8xAKAnZqdXVzCZ+TOjboZ2keLg81eXfW3O+oY=
-github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
 github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
 github.com/golang/snappy v0.0.4 h1:yAGX7huGHXlcLOEtBnF4w7FQwA26wojNCwOYAEhLjQM=
 github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=

diff --git a/http/README.md b/http/README.md
@@ -9,7 +9,7 @@
 
 **Godoc:** https://godoc.org/github.com/getsentry/sentry-go/http
 
-**Example:** https://github.com/getsentry/sentry-go/tree/master/example/http
+**Example:** https://github.com/getsentry/sentry-go/tree/master/_examples/http
 
 ## Installation
 

diff --git a/http/example_test.go b/http/example_test.go
@@ -8,7 +8,7 @@ import (
 )
 
 // For a longer and executable example, see
-// https://github.com/getsentry/sentry-go/tree/master/example/http.
+// https://github.com/getsentry/sentry-go/tree/master/_examples/http.
 func Example() {
 	// Initialize the Sentry SDK once in the main function.
 	// sentry.Init(...)

diff --git a/iris/README.md b/iris/README.md
@@ -9,7 +9,7 @@
 
 **Godoc:** https://godoc.org/github.com/getsentry/sentry-go/iris
 
-**Example:** https://github.com/getsentry/sentry-go/tree/master/example/iris
+**Example:** https://github.com/getsentry/sentry-go/tree/master/_examples/iris
 
 ## Installation
 

diff --git a/martini/README.md b/martini/README.md
@@ -9,7 +9,7 @@
 
 **Godoc:** https://godoc.org/github.com/getsentry/sentry-go/martini
 
-**Example:** https://github.com/getsentry/sentry-go/tree/master/example/martini
+**Example:** https://github.com/getsentry/sentry-go/tree/master/_examples/martini
 
 ## Installation
 

diff --git a/negroni/README.md b/negroni/README.md
@@ -9,7 +9,7 @@
 
 **Godoc:** https://godoc.org/github.com/getsentry/sentry-go/negroni
 
-**Example:** https://github.com/getsentry/sentry-go/tree/master/example/negroni
+**Example:** https://github.com/getsentry/sentry-go/tree/master/_examples/negroni
 
 ## Installation