github.com/palantir/godel-dep-plugin@v1.1.1-0.20201218041358-274eaa9b1310/README.md (about)

     1  <p align="right">
     2  <a href="https://autorelease.general.dmz.palantir.tech/palantir/godel-dep-plugin"><img src="https://img.shields.io/badge/Perform%20an-Autorelease-success.svg" alt="Autorelease"></a>
     3  </p>
     4  
     5  godel-dep-plugin
     6  ================
     7  `godel-dep-plugin` is a [godel](https://github.com/palantir/godel) plugin for [`dep`](https://github.com/golang/dep). It
     8  packages the `dep` program and exposes a task that allows the packaged version of `dep` to be run. It also adds a
     9  `verify` task that runs `dep ensure` when apply is true and `dep ensure -no-vendor -dry-run` when apply is false to
    10  verify that the state of `dep` in a project is valid.
    11  
    12  Tasks
    13  -----
    14  * `dep`: runs the packaged copy of `dep`. All of the arguments that are passed to this task are passed to the packaged
    15    copy of `dep`.
    16  
    17  Verify
    18  ------
    19  When run as part of the `verify` task, if `apply=true`, then the `dep ensure` task is run. If `apply=false`, the
    20  `dep ensure -novendor -dry-run` task is run, and if the task indicates that the `Gopkg.lock` file is out of date, the
    21  verification fails (without output). If the verification task fails for any other reason, the reason for the failure is
    22  printed.