diff --git a/README.md b/README.md index b91c358..81b94bd 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ -[![Build Status](https://travis-ci.org/salesforce/proto-backwards-compat-maven-plugin.svg?branch=master)](https://travis-ci.org/salesforce/proto-backwards-compat-maven-plugin) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.salesforce.servicelibs/proto-backwards-compatibility/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.salesforce.servicelibs/proto-backwards-compatibility) -Protolock Version: [20210127T024023Z](https://github.com/nilslice/protolock/releases/tag/v0.15.1) +Protolock Version: [20210218T172155Z](https://github.com/nilslice/protolock/releases/tag/v0.15.2) # Protobuf Backwards Compatibility Check Maven Plugin -The proto-backwards-compatibility plugin is a Maven plugin to +The `proto-backwards-compatibility` plugin is a Maven plugin to run a backwards compatibility check on a set of protobuf IDL files. The plugin can be integrated into various phases of a maven build to check that any changes to a set of .proto files are backwards compatible. This ensures that these changes do @@ -15,7 +14,8 @@ track of the state of the .proto files. This file is updated when a non-breaking is made, and should be checked in along with any other changes. It is also possible to force any breaking changes and reset the current state -by either +by either + * deleting the proto.lock file. It will then reinitialize the next time the plugin is run. * or by specifying parameter property `acceptBreakingChanges` (`-DacceptBreakingChanges=true`) @@ -27,7 +27,7 @@ https://developers.google.com/protocol-buffers/docs/proto#backwards-compatibilit ## Usage -The os-maven-plugin extension (https://github.com/trustin/os-maven-plugin) +The `os-maven-plugin` extension (https://github.com/trustin/os-maven-plugin) must be added to your project's pom.xml file in order for this plugin to work. ```xml diff --git a/pom.xml b/pom.xml index cb06c96..dc0bb92 100644 --- a/pom.xml +++ b/pom.xml @@ -12,7 +12,7 @@ com.salesforce.servicelibs proto-backwards-compatibility maven-plugin - 1.0.7-SNAPSHOT + 1.0.7T Proto Backwards Compatibility Maven Mojo A Maven plugin for analyzing protobuf backwards compatible changes.