cybercyst/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-05-05 23:53:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

I had previously added 'go mod -sync' as a step for the 'Preparing a release' section. Given that, updated step #3 in 'Defining a module' section: rather than 'go mod -sync', say 'go build ./...', which seems more to be the norm (e.g., based on spot checking a couple recent rsc examples). Overall, this section could still be improved/clarified.

thepudds 2018-07-31 13:31:00 -04:00
parent 94d48cbf68
commit 74241a19c1
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Modules.md

@ -103,13 +103,11 @@ To create a `go.mod` for an existing project, follow the following steps.
$ go mod -init -module example.com/path/to/my/module/v2 $ go mod -init -module example.com/path/to/my/module/v2
``` ```
3. Build the module. This will automatically add missing or unconverted dependencies as needed to satisfy imports for this particular build invocation:
3. The `-sync` flag synchronizes the `go.mod` file with the source code in the module (filling in requirements for any missing or unconverted dependencies, and removing modules that are not needed to satisfy any imports):
``` ```
$ go mod -sync $ go build ./...
``` ```
4. Test the module as configured to ensure that it works with the selected versions. 4. Test the module as configured to ensure that it works with the selected versions.
``` ```
@ -122,6 +120,8 @@ To create a `go.mod` for an existing project, follow the following steps.
$ go test all $ go test all
``` ```
Prior to tagging a release, see the [Preparing a release](https://github.com/golang/go/wiki/Modules#preparing-a-release) section below.
## Upgrading and Downgrading Dependencies ## Upgrading and Downgrading Dependencies
Day-to-day adding, removing, upgrading, and downgrading of dependencies should be done using 'go get', which will automatically update the `go.mod` file. Day-to-day adding, removing, upgrading, and downgrading of dependencies should be done using 'go get', which will automatically update the `go.mod` file.