From 3d512cb8b4201c2236e98353a04566604fcd24b0 Mon Sep 17 00:00:00 2001 From: Rhys Arkins <rhys@arkins.net> Date: Sat, 8 Dec 2018 17:01:08 +0100 Subject: [PATCH] docs: update golang --- website/docs/golang.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/website/docs/golang.md b/website/docs/golang.md index 655bfa3bdb..ce1b5816fb 100644 --- a/website/docs/golang.md +++ b/website/docs/golang.md @@ -11,17 +11,14 @@ Renovate supports upgrading dependencies in `go.mod` files and their accompanyin 1. Renovate will search each repository for any `go.mod` files. 2. Existing dependencies will be extracted from `require` statements -3. Renovate will resolve the dependency's source repository and check for semver tags if found (GitHub-only currently) -4. If the source repository has either a "changelog" file or uses GitHub releases, then Release Notes for each version will be embedded in the generated PR. +3. Renovate will resolve the dependency's source repository and check for semver tags if found +4. A PR will be created with `go.mod` and `go.sum` updated in the same commit +5. If the source repository has either a "changelog" file or uses GitHub releases, then Release Notes for each version will be embedded in the generated PR. ## Enabling -Install the [Renovate App](https://github.com/marketplace/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) or [Renovate Pro](https://renovatebot.com/pro) for self-hosted options. +Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) or [Renovate Pro](https://renovatebot.com/pro) for self-hosted options. -## Limitations / Future work +## Future work -- [#2580](https://github.com/renovatebot/renovate/issues/2580) Support vendoring of dependencies (i.e. Renoate updating the `vendor/` directory in same PR) - -- [#2583](https://github.com/renovatebot/renovate/issues/2583) Support major version updates >1 (requires changing the dependency "name" in both `go.mod` as well as source files that reference it) - -- [#2586](https://github.com/renovatebot/renovate/issues/2586) Updating commit hashes in `go.mod` files for dependencies that don't yet support tagged versions +- [#2580](https://github.com/renovatebot/renovate/issues/2580) Support vendoring of dependencies (i.e. Renovate updating the `vendor/` directory in same PR as it update `go.mod` and `go.sum`) -- GitLab