From 89e8c6df288214a19f7c0da0205d4e7f40a2c1a6 Mon Sep 17 00:00:00 2001 From: Peter Edge Date: Sun, 31 Mar 2019 12:50:10 -0400 Subject: [PATCH] Update default version of protoc to 3.7.1 --- CHANGELOG.md | 2 +- docs/README.md | 2 +- docs/development.md | 8 +++++++- docs/faq.md | 2 +- docs/protoc.md | 4 ++-- etc/config/example/prototool.yaml | 4 ++-- example/proto/prototool.yaml | 2 +- internal/reflect/proto/prototool.yaml | 2 +- internal/vars/vars.go | 2 +- 9 files changed, 17 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 39ddf7b7..187ff818 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] -- No changes yet. +- Update the default version of `protoc` to `3.7.1`. ## [1.4.0] - 2019-03-19 diff --git a/docs/README.md b/docs/README.md index 7161e233..d286580c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -122,7 +122,7 @@ Recommended base config file: ```yaml protoc: - version: 3.7.0 + version: 3.7.1 lint: group: uber2 ``` diff --git a/docs/development.md b/docs/development.md index 4a88ffec..3dafe805 100644 --- a/docs/development.md +++ b/docs/development.md @@ -26,4 +26,10 @@ Before submitting a PR, make sure to: The entire implementation is purposefully under the `internal` package to not expose any API for the time being. -For maintainers: See [release.md](release.md) for the release process. +## Maintainers + +See [release.md](release.md) for the release process. + +See https://github.com/uber/prototool/pull/417 for an example of how to update the default version +of `protoc`. Note that `etc/config/example/prototool.yaml` is automatically updated once you +update `DefaultProtocVersion` in `internal/vars/vars.go` and you run `make generate`. diff --git a/docs/faq.md b/docs/faq.md index ff5bc195..09ff1d6a 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -17,7 +17,7 @@ prototool cache update # Cache to a specific directory path/to/cache prototool cache update --cache-path path/to/cache # Cache using custom configuration data instead of finding a prototool.yaml file using the file discovery mechanism -prototool cache update --config-data '{"protoc":{"version":"3.7.0"}}' +prototool cache update --config-data '{"protoc":{"version":"3.7.1"}}' ``` There is also a command `prototool cache delete` which will delete all cached assets of diff --git a/docs/protoc.md b/docs/protoc.md index daab09b1..94da75c7 100644 --- a/docs/protoc.md +++ b/docs/protoc.md @@ -21,12 +21,12 @@ for more details. - Otherwise, if on Linux, `$HOME/.cache/prototool` will be used, or on Darwin, `$HOME/Library/Caches/prototool` will be used. -By default, `protoc` version `3.7.0` is downloaded, however this is configurable in your +By default, `protoc` version `3.7.1` is downloaded, however this is configurable in your `prototool.yaml` file. ```yaml protoc: - version: 3.7.0 + version: 3.7.1 ``` Downloads are safe to run concurrently across processes, for example if using from Bazel, as diff --git a/etc/config/example/prototool.yaml b/etc/config/example/prototool.yaml index 77bb9ff9..2047fe31 100644 --- a/etc/config/example/prototool.yaml +++ b/etc/config/example/prototool.yaml @@ -8,9 +8,9 @@ excludes: # Protoc directives. protoc: # The Protobuf version to use from https://github.com/protocolbuffers/protobuf/releases. - # By default use 3.7.0. + # By default use 3.7.1. # You probably want to set this to make your builds completely reproducible. - version: 3.7.0 + version: 3.7.1 # Additional paths to include with -I to protoc. # By default, the directory of the config file is included, diff --git a/example/proto/prototool.yaml b/example/proto/prototool.yaml index 1fbf76b4..964fa214 100644 --- a/example/proto/prototool.yaml +++ b/example/proto/prototool.yaml @@ -1,5 +1,5 @@ protoc: - version: 3.7.0 + version: 3.7.1 lint: group: uber2 rules: diff --git a/internal/reflect/proto/prototool.yaml b/internal/reflect/proto/prototool.yaml index dd85d1af..e4add002 100644 --- a/internal/reflect/proto/prototool.yaml +++ b/internal/reflect/proto/prototool.yaml @@ -1,5 +1,5 @@ protoc: - version: 3.7.0 + version: 3.7.1 lint: group: uber2 generate: diff --git a/internal/vars/vars.go b/internal/vars/vars.go index d6393061..b98a5e07 100644 --- a/internal/vars/vars.go +++ b/internal/vars/vars.go @@ -29,5 +29,5 @@ const ( // github.com/protocolbuffers/protobuf to use. // // See https://github.com/protocolbuffers/protobuf/releases for the latest release. - DefaultProtocVersion = "3.7.0" + DefaultProtocVersion = "3.7.1" )