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.

Sign up for GitHub

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

Jump to bottom

Update readme groupID references #668

Merged
merged 3 commits into from Oct 3, 2022
Merged

Update readme groupID references #668

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
764aa31
update envoyproxy references in readme
elliotmjackson Oct 3, 2022
4138ecb
update envoyproxy references in readme
elliotmjackson Oct 3, 2022
b52b8fb
Update README.md
elliotmjackson Oct 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Expand Up @@ -2,8 +2,8 @@

# protoc-gen-validate (PGV)

![License](https://img.shields.io/github/license/envoyproxy/protoc-gen-validate?color=blue)
![Release](https://img.shields.io/github/v/release/envoyproxy/protoc-gen-validate?include_prereleases)
![License](https://img.shields.io/github/license/bufbuild/protoc-gen-validate?color=blue)
![Release](https://img.shields.io/github/v/release/bufbuild/protoc-gen-validate?include_prereleases)
![Slack](https://img.shields.io/badge/slack-buf-%23e01563)

*This project is currently in **alpha**. The API should be considered unstable and likely to change*
Expand Down Expand Up @@ -78,9 +78,15 @@ Installing PGV can currently only be done from source:
```sh
# fetches this repo into $GOPATH
go get -d github.com/envoyproxy/protoc-gen-validate
```

> #### 💡 Yes, our go module path is `github.com/envoyproxy/protoc-gen-validate` **not** `bufbuild` this is intentional.
> Changing the module path is effectively creating a new, independent module. We would prefer not to break our users. The Go team are working on better `cmd/go` support for modules that change paths, but progress is slow. Until then, we will continue to use the `envoyproxy` module path.

```
git clone github.com/bufbuild/protoc-gen-validate
# installs PGV into $GOPATH/bin
make build
cd protoc-gen-validate && make build
```

### Parameters
Expand Down Expand Up @@ -125,7 +131,7 @@ following to your pom.xml or build.gradle.
```xml
<dependencies>
<dependency>
<groupId> io.envoyproxy.protoc-gen-validate</groupId>
<groupId>build.buf.protoc-gen-validate</groupId>
<artifactId>pgv-java-stub</artifactId>
<version>${pgv.version}</version>
</dependency>
Expand Down Expand Up @@ -156,7 +162,7 @@ following to your pom.xml or build.gradle.
<configuration>
<pluginParameter>lang=java</pluginParameter>
<pluginId>java-pgv</pluginId>
<pluginArtifact>io.envoyproxy.protoc-gen-validate:protoc-gen-validate:${pgv.version}:exe:${os.detected.classifier}</pluginArtifact>
<pluginArtifact>build.buf.protoc-gen-validate:protoc-gen-validate:${pgv.version}:exe:${os.detected.classifier}</pluginArtifact>
</configuration>
</execution>
</executions>
Expand All @@ -179,7 +185,7 @@ protobuf {

plugins {
javapgv {
artifact = "io.envoyproxy.protoc-gen-validate:protoc-gen-validate:${pgv.version}"
artifact = "build.buf.protoc-gen-validate:protoc-gen-validate:${pgv.version}"
}
}

Expand Down