diff --git a/docs/using-the-plugin.md b/docs/using-the-plugin.md index 0eba1435..cdad2088 100644 --- a/docs/using-the-plugin.md +++ b/docs/using-the-plugin.md @@ -234,6 +234,18 @@ It's really simple to setup this plugin; below is a sample pom that you may base --> false + + <-- + Default (optional): + false + + Explanation: + When set to `true`, the plugin will not try to contact any remote repositories. + Any operations will only use the local state of the repo. If set to `false`, it will execute `git fetch` operations + e.g. to determine the `ahead` and `behind` branch information. + --> + false +