Modules
Russ Cox edited this page 2023-12-14 22:14:45 -05:00

Wiki Page Revisions

380 Commits

Author SHA1 Message Date
thepudds
b9b0248de1 adjust 'go.mod' section; various other minor tweaks 2018-12-19 10:42:59 -05:00
Jeevanandam M
f632a5f384 Added note about thumbai mod proxy info 2018-12-15 17:03:26 -08:00
thepudds
3568a32f9f fix extra word 2018-12-14 09:01:44 -05:00
thepudds
6a3214d0f5 adjust new "Quick Start" slightly; other minor adjustments 2018-12-14 08:59:46 -05:00
Komu Wairagu
4529003b37 changed from `Note that if you adopting` to `Note that if you are adopting` 2018-12-14 09:52:47 +03:00
thepudds
3a7131bae5 small tweak 2018-12-13 13:46:33 -05:00
thepudds
f509165108 adjust formatting of "Quick Start" section 2018-12-13 13:34:55 -05:00
thepudds
bb4f9f0a39 briefly explain './...' 2018-12-13 13:24:11 -05:00
thepudds
dc9d7bca84 transition "Quick Start Example" section to a "Quick Start" section 2018-12-13 13:14:12 -05:00
thepudds
8197fef731 provide example 'go list' invocation to show exact versions used in your build excluding test-only dependencies (from #26955) 2018-12-12 09:19:32 -05:00
thepudds
3c948ab3c2 minor tweaks to recent material 2018-12-11 08:59:09 -05:00
thepudds
ae770a2c69 use github.com/my/repo in one of the examples rather than example.com/my/project 2018-12-10 18:06:32 -05:00
thepudds
f7452d4baa expanded general purpose troubleshooting FAQs 2018-12-09 08:59:32 -05:00
thepudds
192b1f5261 expanded general purpose troubleshooting FAQs 2018-12-09 08:55:19 -05:00
thepudds
e8762f6d8d and new FAQs to TOC 2018-12-07 17:33:00 -05:00
thepudds
7e5e2cd2a6 some edits to "minimal module compatibility" FAQ. (Still a bit rough). 2018-12-07 17:18:37 -05:00
thepudds
3b6d8aa73b some edits to '+incompatible' FAQ 2018-12-07 16:21:51 -05:00
thepudds
bfa9eca33c minor tweaks to recent material 2018-12-07 12:53:41 -05:00
thepudds
584c4bb6fd minor tweaks to recent material 2018-12-07 12:23:45 -05:00
thepudds
35618665ab s/Subdirectory/Branch/ 2018-12-07 12:04:28 -05:00
thepudds
28f8551e71 minor tweaks to recent material 2018-12-07 11:49:19 -05:00
thepudds
ba32a3a989 minor tweaks to recent material 2018-12-07 11:28:49 -05:00
thepudds
b0ad9149b9 minor tweaks to recent material 2018-12-07 11:21:44 -05:00
thepudds
57f8e21722 add brief discussion of 'goforward'; small tweaks to recent material 2018-12-07 11:16:10 -05:00
thepudds
93dda5aabb TOC update 2018-12-07 10:43:54 -05:00
thepudds
a275119bd1 add the new entries to TOC 2018-12-07 10:41:52 -05:00
thepudds
8cca0bafd5 add two general purpose troubleshooting FAQs, and two FAQs on two of the most common specific error messages 2018-12-07 10:32:11 -05:00
thepudds
83477c0cb0 expand vendor FAQ; drop older FAQ on 'go mod' commands changing in go1.11beta3 2018-12-07 08:56:31 -05:00
thepudds
365c05ac6d add new 'Migration Considerations' section. (Work-in-progress; hopefully will improve over time as best practices emerge from the community). 2018-12-07 06:50:29 -05:00
thepudds
c3ee9b5908 slightly expand the answer to 'Is go.sum a lock file?' 2018-12-06 08:30:43 -05:00
thepudds
10bb4b3436 add three new detailed FAQs on +incompatible, "minimal module awareness", and importing non-module packages. (Still a bit rough; will hopefully polish later with fresh eyes). 2018-12-05 18:59:16 -05:00
thepudds
c6470bae98 attempt to more clearly enumerate the exceptions/special cases in the 'Semantic Import Versioning' section (and some other misc. cleanup) 2018-12-05 11:47:23 -05:00
thepudds
89bb22547a expand 'Semantic Import Versioning' section a bit 2018-12-04 16:57:59 -05:00
thepudds
1290328585 mention 'go list -m all' is useful to confirm a 'replace' statement is giving you what you expect 2018-12-04 10:21:46 -05:00
thepudds
c4a1c1ed95 expand 'replace' FAQs 2018-12-04 09:53:19 -05:00
thepudds
f75aafd02d make it clearer that tagging a module release is the act that publishes a release 2018-12-03 22:04:28 -05:00
thepudds
026d4d24e8 don't use 'foo' for a package name in 'Releasing Modules (v2 or Higher)' section 2018-12-03 15:13:41 -05:00
thepudds
ce12998148 add comment in 'Releasing Modules (v2 or Higher)' section regarding advice to increment major version when first adopting modules for a pre-existing v2+ package 2018-12-03 12:50:28 -05:00
thepudds
bfe9515498 provide a slightly longer explanation of the 'tools.go' approach along with a pointer to a "Go Modules by Example" walkthrough; also fix an FAQ link that someone broke, and swap ordering of two FAQs 2018-12-01 09:44:05 -05:00
Paul Jolly
49a68a2600 Updated Modules (markdown) 2018-12-01 04:52:12 +00:00
thepudds
703a923285 Additional tweak to ‘gobin’ description 2018-11-30 09:42:24 -05:00
thepudds
8b0321f766 Small tweak to ‘gobin’ description 2018-11-30 09:36:49 -05:00
thepudds
9f0f515751 add pointer to 'gobin', along with high-level description 2018-11-30 09:01:04 -05:00
thepudds
dced9ebda8 add a paragraph on why you can end up with '// indirect' require directives if you run 'go get -u' or otherwise upgrade an indirect dependency 2018-11-29 06:37:22 -05:00
thepudds
e15da1bd24 mention in "How to Define a Module" that 'go mod init' does not add '/vN' to the dependencies listed in 'go.mod', or at least, it does not always do so. 2018-11-25 12:58:59 -05:00
x1ah
2e74f8287c Updated Modules (markdown) 2018-11-22 14:45:57 +08:00
thepudds
ccab1c3cb9 make it clearer that a new branch is not a requirement for the 'Major Branch' strategy for a v2+ module 2018-11-20 10:18:36 -05:00
thepudds
cf232d2c35 tweak wording around 'go get foo' and also add mention of 'go get foo@latest' 2018-11-02 17:58:22 -04:00
Matthew Cale
a913f0e851 non-major grammar mod. commonly accepted as the better option. 2018-10-23 15:58:35 -05:00
Alexei Vainshtein
c41c593e26 Updated Modules (markdown) 2018-10-18 13:54:22 +03:00
Alexei Vainshtein
07fcfa132a Updated Modules (markdown) 2018-10-18 13:54:04 +03:00
Dmitry Savintsev
7df33ca689 Updated Modules (markdown) 2018-10-12 13:55:43 +02:00
Dmitry Savintsev
660f1e3b73 update last FAQ for go1.11 and include 'go mod help' output 2018-10-12 13:49:21 +02:00
Dmitry Savintsev
07c9647f0f remove 'go mod fix' as subcommand 2018-10-12 13:40:08 +02:00
thepudds
e4ddd27b2f minor cleanup of checking in go.sum FAQ (content here had been moved from 'How to...' section to break it out as a FAQ) 2018-10-09 10:16:32 -04:00
Paul Jolly
b12f08b69b Add reference on go.sum question 2018-10-08 12:18:21 +01:00
Paul Jolly
7db1d08b15 Updated Modules (markdown) 2018-10-08 12:16:45 +01:00
Paul Jolly
b64be36468 Create specific section on whether to commit go.sum file and start reference from existing section 2018-10-08 12:15:43 +01:00
thepudds
1adc543ca9 tweak table of contents 2018-10-05 00:18:57 -04:00
thepudds
27d36431fd update table of content for new sub-sections in 'How to Prepare for a Release' section 2018-10-04 23:54:43 -04:00
thepudds
d293f2902a update the 'go.mod' section, including provide a simple tree showing an example on-disk structure; additional minor improvement to 'Semantic Import Versioning' section 2018-10-04 23:45:35 -04:00
thepudds
725fdf3163 some updates to Semantic Import Versioning and v2+ upgrade instructions 2018-10-04 22:50:12 -04:00
Sylvain Laurent
5b4c4e0732 Add notes on "missing" files in vendor directory 2018-10-03 17:02:28 +02:00
thepudds
23256d19f0 smaller tweak to FAQ on why 'go mod tidy' brings in indirect and test dependencies 2018-09-29 10:31:34 -04:00
thepudds
e392e8e551 expand and attempt to slightly clarify the FAQ on why 'go mod tidy' brings in indirect and test dependencies 2018-09-29 10:22:51 -04:00
Bryan C. Mills
4635c4e729 Refer to “major branch” and “major subdirectory” conventions (using the terminology from https://research.swtch.com/vgo-module) 2018-09-28 14:16:38 -04:00
thepudds
5dd795acc3 include pointer to VS Code module beta and module support wiki page 2018-09-24 23:57:51 -04:00
thepudds
423dee0cf1 mention again that 'go.sum' should be checked in in the 'go.sum' FAQ (this continues to come up); additional minor improvements to the 'How to Define a Module' section 2018-09-24 22:52:54 -04:00
thepudds
7eb5d6fc58 provide a bit more context and explanation in the 'How to Define a Module' section; update the GitHub searches 2018-09-24 22:48:23 -04:00
thepudds
979093a9d8 finish up table of content modifications 2018-09-24 22:14:19 -04:00
thepudds
7afc40dd25 second half of adding structure to FAQs; expand SIV FAQs. 2018-09-24 22:06:51 -04:00
thepudds
885ec5c5e7 remote pre-beta3 syntax; adjust the table of contents to make the overall structure of the page clearer; introduce sub-sections for the now long-ish FAQ section; re-order sections 2018-09-24 21:46:42 -04:00
thepudds
12d4be05e7 correct one of the replace examples 2018-09-24 00:23:47 -04:00
thepudds
05465dd873 move the more complex steps for v2+ modules out of the 'Semantic import versioning' concepts section and into the 'How to prepare a release section'; make more explicit; refer directly to github.com/marwan-at-work/mod as an option for automating the steps for v2+ modules 2018-09-23 16:22:19 -04:00
thepudds
720dd65d96 provide a new quick start example; consolidate intro paragraphs and ask for feedback upfront via experience reports; re-order first few sections 2018-09-23 15:05:57 -04:00
AJ ONeal
21fc7f113d add concise, follow-along examples for the uninitiated (what I wish I had had) 2018-09-20 14:06:57 -06:00
thepudds
d86f5aa127 one more sentence for `go.sum` FAQ stating `go.sum` captures everything in a build; also move the other 'go.mod' FAQ to be immediately after the go.mod/go.sum FAQs 2018-09-17 10:21:31 -04:00
thepudds
7f6103bc50 update link in table of contents to the new FAQ 2018-09-17 10:03:25 -04:00
thepudds
58207da868 update 'go mod tidy' FAQ (provide a little more context up front; re-order paragraphs; tweak text); add FAQ on whether or not 'go.sum' is a lock file and why 'go.sum' retains information after you stop using something 2018-09-17 09:57:11 -04:00
thepudds
9825ccbd57 pull in 3 of the older proposal-era FAQs into the table of contents (with link that will take you to the older FAQs) 2018-09-08 10:38:44 -04:00
thepudds
2560fb3039 vgo is still stale, so remove vgo install instructions at least for now. Someone can still find the vgo repo if they are interested 2018-09-08 09:12:48 -04:00
Filippo Valsorda
6a7f77384c Updated Modules (markdown) 2018-09-08 01:55:06 -04:00
thepudds
0adc829c6e add pointer in the `replace` FAQ back to the `go.mod` concepts section 2018-09-07 10:05:32 -04:00
thepudds
343420be08 explicitly mention less sensitive to change to avoid the version on the left side of a replace statement; add pointer to `replace` FAQ from section on go.mod 2018-09-07 09:59:22 -04:00
Bryan C. Mills
85d7baf93f clarify grammar in “go mod tidy” section 2018-09-07 09:14:59 -04:00
thepudds
32421f0805 minor tweaks to a couple of the just-added FAQs 2018-09-07 02:14:16 -04:00
thepudds
122bf9b6ba move GOPROXY/Athens/JFrog FAQ up to be next to vendoring FAQ (and some other minor table of contents tweaks) 2018-09-07 02:04:45 -04:00
thepudds
f445693a53 add the FAQ one-liners to the table of contents 2018-09-07 01:51:55 -04:00
thepudds
636e98dc9f added 3 more FAQs (community tooling, replace directives, and working outside of VCS) 2018-09-07 01:38:02 -04:00
thepudds
844650504e move FAQ on `go mod` changes in beta3 to the end (but keeping around, given some older blogs use the older commands) 2018-09-07 01:09:12 -04:00
thepudds
00c21b7334 added 4 more FAQs (on CI, why so many indirect dependencies, vendoring, disabling network access/readonly) 2018-09-07 01:00:11 -04:00
thepudds
856618c1ca add 3 new FAQs on adding a `go.mod` as a leaf package without any dependencies, restrictions on ./subdir imports, and why gcc might be required 2018-09-07 00:20:35 -04:00
thepudds
868cbbc6b2 tweak `go get` FAQ (slightly this time) 2018-09-06 23:59:14 -04:00
thepudds
320b62445b take a stab at simplifying the `go get` fails outside of modules FAQ, and outline a couple more options, including a script put together by rogpeppe; also slightly simplify the tool status FAQ 2018-09-06 23:52:46 -04:00
thepudds
345f56262f update additional references section (now that modules are out, some better or more up-to-date blogs have been written) 2018-09-06 08:55:00 -04:00
thepudds
ab3a7ede3b provide some additional detail on the minimal module awareness introduced in 1.9.7+ and 1.10.3+ 2018-09-05 09:14:13 -04:00
_eternal_flame
f1083d2b1a fix a broken link to the proposal document 2018-09-05 09:13:00 +08:00
thepudds
21780395f6 mention that 1.11 was also updated to understand the use of SIV by code that has opted in to modules (even if module awareness is disabled, for example) 2018-09-02 16:10:43 -04:00
thepudds
b488c3af85 add FAQ on editor, IDE and related tool support for modules 2018-09-02 12:26:20 -04:00
thepudds
a0c342a175 shrink down the 'Recent History' section to a single sentence. 2018-09-02 09:23:03 -04:00
thepudds
738d95c3fb delete sentence in 'Version selection' example to make it a bit shorter 2018-08-29 08:37:13 -04:00
thepudds
bacacf017d one more tweak to 'Version selection' section 2018-08-29 00:39:38 -04:00
thepudds
2b5afbd3fb mention explicitly that `go.mod` provides enough information for reproducible builds without `go.sum` being a lock file. (Some people think of `go.sum` as a lock file). 2018-08-29 00:35:43 -04:00
thepudds
12e9b8faa5 eliminate second use of 'introduce' in sentence in 'Version Selection' section 2018-08-29 00:20:21 -04:00
thepudds
7806bc7bdc slightly expand minimal version selection example again 2018-08-29 00:16:41 -04:00
thepudds
def8ca7a63 tweak intro 2018-08-28 17:26:39 -04:00
thepudds
cc84ca2ac9 slightly expand intro 2018-08-28 17:24:14 -04:00
thepudds
3e96807c38 one more tweak to wording in 'minimal version selection' example 2018-08-28 16:01:45 -04:00
thepudds
def87cb213 tweak the small 'minimal version selection' example one more time 2018-08-28 15:57:41 -04:00
thepudds
40dae3efe9 slightly shrink the new FAQ 2018-08-28 15:16:21 -04:00
thepudds
c0b571cbe7 the just-added url to new FAQ had issue 2018-08-28 15:03:24 -04:00
thepudds
cb4e8b549f update MVS example, including more explicitly work in the phrase "100% reproducible builds"; also draw stronger contrast between `go mod tidy` vs. `go build`; move proxy discussion into FAQ (prior level of detail didn't really belong up front) 2018-08-28 15:01:45 -04:00
thepudds
038b77ea12 clarify FAQ on when old vs. new behavior kicks in; also add missing paren from prior edit 2018-08-28 12:20:18 -04:00
thepudds
b158533b5b flip order of explanation for why `go mod tidy` is useful, and provide a more targeted pointer to explanation how `go mod tidy` reflects all possible build tags/OS/architecture combinations 2018-08-28 12:15:26 -04:00
Baruch Sadogursky
4c8cef3877 JFrog Artifactory 2018-08-28 07:19:09 -06:00
Baruch Sadogursky
43df1131a5 Added JFrog Artifactory 2018-08-28 07:18:04 -06:00
thepudds
f43537c729 add word 'optional' to Project Athens parenthetical. some people think everyone will be required to run their on GOPROXY 2018-08-26 12:49:26 -04:00
thepudds
8ff454410e add a v2+ example to the first go.mod example; remove sentence about ability to quote module paths (given its usefulness is more a corner case that doesn't need to be covered so early in introductory material) 2018-08-26 12:45:52 -04:00
thepudds
7ce45c3b73 slightly shrink the CI bullet; slightly shrink recent history bullet 2018-08-26 12:41:13 -04:00
thepudds
5978cee39e slightly expand the proxy/Project Athens parenthetical. 2018-08-26 12:36:33 -04:00
thepudds
90d81be98d explicitly mention the `v` in required in semver tags; mention modules can consume non-modules and unversioned packages 2018-08-26 12:21:40 -04:00
thepudds
93bae8f136 shorten one of the FAQs slightly 2018-08-25 22:39:46 -04:00
thepudds
15f1244f1d let's not use the past tense with 'added' in our first sentence. (Modules are a journey!) 2018-08-25 22:01:50 -04:00
thepudds
49436e526b light update to reflect Go 1.11 was officially released 2018-08-25 22:00:24 -04:00
thepudds
586c5c0807 include quote to further explain why #24250 is not in 1.11. (People are continuing to express surprise about this). 2018-08-25 21:37:33 -04:00
thepudds
e24c771a52 tweak formatting for the FAQs I just added 2018-08-25 15:09:57 -04:00
thepudds
758e608d49 add 3 more FAQs on: why `go get example.com/cmd` fails with error `cannot find main module` when run outside of module; how to track tool dependencies of a specific module; and summarize the GO111MODULE/GOPATH behavior 2018-08-25 15:02:30 -04:00
thepudds
ff8f0f8297 mention `go get ...@master` as one way to obtain the latest commit 2018-08-25 13:07:59 -04:00
thepudds
23d2952d75 add additional pointer to semver in 'Semantic Import Versioning' section 2018-08-25 13:00:46 -04:00
thepudds
01c7434d49 expand the 'Semantic Import Versioning' section, including quote the old versioning advice from the FAQ, quote the import compatibility rule, attempt to tie them together 2018-08-25 10:49:21 -04:00
thepudds
656e835e1e simplify 'Semantic Import Versioning' section (and the pointer to the doc has more details) 2018-08-21 15:32:45 -04:00
thepudds
ca810be451 #26594 is now addressed, though not 100% clear exactly which released fixed it (rc1 vs. maybe requires rc2) 2018-08-19 10:34:08 -04:00
thepudds
6ae9d6f199 mention `go list -m all` to see versions of direct and indirect dependencies 2018-08-15 15:52:57 -04:00
thepudds
d8674ab1c8 expand `go test all` description slightly 2018-08-15 15:22:10 -04:00
thepudds
3d101f0792 small clean up to new go.sum section 2018-08-15 14:19:10 -04:00
thepudds
2999a1b654 small clarification to the CI section (those version identifiers are in theory the exact strings to use for RC1) 2018-08-15 13:22:54 -04:00
thepudds
d5e66eeaa4 small clarification on `go test all` 2018-08-15 13:20:27 -04:00
thepudds
c53293c317 use friendlier example module path for first time a module path shows up in the overall text 2018-08-15 13:05:09 -04:00
thepudds
e508c057ef minor formatting 2018-08-15 12:57:00 -04:00
thepudds
72779d82b0 include reference to pseudo-versions in module query introduction; use friendlier example modules for the intro `go.mod` shown and clean up related text 2018-08-15 12:48:53 -04:00
thepudds
56644ef83d the much older phrase of 'post v1 tags' is not really correct or at least open to misinterpretation -- 'v2+ tags' is clearer 2018-08-15 12:14:07 -04:00
thepudds
d0ef5ad484 mention option of a `v2.0.0` release on master along with the subsequent suggestion for a v1 branch (option outlined in official proposal FAQ); also provide an explicit pointer back to this v2+ discussion from the 'Releasing a module' section; adjust the older "still in flux" comment regarding v2+ modules 2018-08-15 12:07:14 -04:00
thepudds
aa43ea412e in 'Semantic import versioning' concepts section: include more explicit pointer to semantic import version section of tip documentation; mention the actual older versions 1.9.7 and 1.10.3 that now have minimal module awareness; mention that the '/v2' subdirectory approach allows for compatibility with even older Go versions and make the description a bit more specific 2018-08-15 11:52:47 -04:00
thepudds
b98d7cfb9b add pointer to brief rationale on checking in go.sum (currently a *very* brief rationale in the form of tweet from FiloSottile) 2018-08-15 09:39:44 -04:00
thepudds
abb30ff4d8 add a recommendation to typically check in `go.sum` (e.g., see https://twitter.com/FiloSottile/status/1029404663358087173); also mention that `go.sum` is not a traditional lock file, which is a question that comes up somewhat frequently 2018-08-15 09:32:02 -04:00
thepudds
9bd627b31a provide better instructions and better pointer on using RC1 with CircleCI 2018-08-14 18:59:50 -04:00
thepudds
0cd38b59ee 1.11rc1 is now available as a known go release in gimme (install utility used by Travis), so update to say 1.11rc1 in CI bullet 2018-08-13 23:38:15 -04:00
thepudds
f6ee899d65 update link to rc1 2018-08-13 23:09:48 -04:00
thepudds
f1bba83b46 update for go1.11rc1 2018-08-13 22:48:59 -04:00
thepudds
8d39bc32d5 also remove a reference to the -module flag from a piece of the prose 2018-08-13 13:34:49 -04:00
thepudds
6f434efffc update some of the instructions now that vgo has been updated to support the new form of `go mod` commands 2018-08-13 13:29:51 -04:00
thepudds
140883f9f9 add pointer to thread discussing adding betas to CI; also include pointers to sample Travis config for go11.1beta3, and a sample CircleCI config for a matrix build in CircleCI 2.0 (though would like to find a better go-specific CircleCI example) 2018-08-13 13:10:20 -04:00
thepudds
73a90f01f8 given vgo has recently been updated to align with beta 3, remove related comment about vgo 2018-08-13 12:38:11 -04:00
thepudds
80d05d310f move the statement up semver up higher 2018-08-13 07:38:09 -04:00
thepudds
170f51d829 faq —> FAQ 2018-08-09 06:41:45 -04:00
Dmitry Savintsev
8acd0a7c2c fix typo (or or) 2018-08-08 12:35:38 +02:00
Dmitry Savintsev
cff8bfd860 replace go1.11beta2 with go1.11beta3 2018-08-08 12:33:40 +02:00
Dmitry Savintsev
42a394cc47 typo fix in relative link 2018-08-08 12:30:43 +02:00
Dmitry Savintsev
763d3adc63 fix the relative link to modules go111beta3 faq 2018-08-08 12:29:29 +02:00
Dmitry Savintsev
0e8db236b4 reflect that the new go mod maintenance commands are in go1.11beta3 2018-08-08 12:28:04 +02:00
thepudds
432bda3bd5 add yet another pointer to the official documentation 2018-08-07 05:22:33 -04:00
thepudds
601d2319cb make it slightly clearer that the discussion around possible additional forms of declarations of incompatibilities are only possible avenues / not set in stone 2018-08-06 23:26:24 -04:00
thepudds
55989cc27b add reference to -mod=readonly / -mod=vendor / GOPROXY=off CL in recent changes section 2018-08-05 20:39:02 -04:00
thepudds
74c22d7241 typo: s/pkg/package/ 2018-08-05 12:50:37 -04:00
thepudds
4975e284a1 wording tweak 2018-08-05 12:47:20 -04:00
thepudds
8b04a413b2 remove parentheses 2018-08-05 12:45:47 -04:00
thepudds
d1ceca765f remove text that asserted v1 and v2 of a module are different modules (not sure that's true, but in any event likely clearer to talk about different packages; was hold-over text from several months ago when this was the 'vgo user guide' wiki) 2018-08-05 12:43:01 -04:00
thepudds
0e8012e671 attempt to simplify the intro concepts discussion on modules, go.mod, with more pointers to encourage people to read the proposal and official doc; also move the older (and perhaps somewhat confusing to a newcomer) v2+ discussion to live in the semantic versioning section. (Overall, much of text touched here was hold-over from several months ago when this was the 'vgo user guide' wiki) 2018-08-05 12:24:11 -04:00
thepudds
14331908c7 re-arrange order of concepts sections (no other edits). 2018-08-05 12:09:17 -04:00
Fazlul Shahriar
5c82840024 correct go1.11beta3 release date 2018-08-05 12:07:17 -04:00
thepudds
162ccfea92 add pointer to Kubernetes planning on adopting vgo/modules 2018-08-05 11:27:29 -04:00
thepudds
1da29f6c66 add faq on what do when project has historically made breaking changes without bumping the major version (answer currently references recent k8s comment from rsc) 2018-08-05 11:19:52 -04:00
thepudds
7b9e5bb1ee add one more open issue where old git is problematic 2018-08-05 09:55:03 -04:00
thepudds
a7ce6d780f update with pointer to beta 3 release announcement; include pointers to some issues that appear to be regressions from beta 2 2018-08-05 09:34:37 -04:00
thepudds
1019461636 missing 'd' 2018-08-03 18:27:01 -04:00
thepudds
15f25cac99 get ready for go1.11beta3 by updating 'go mod' commands 2018-08-03 18:24:51 -04:00
thepudds
42f1dea985 make one of the 'Changes...' bullets less wordy 2018-08-03 18:07:15 -04:00
thepudds
caf7729cac last edit should have been a 'mv', not 'cp' 2018-08-03 18:03:29 -04:00
thepudds
a7d3054461 move up request for continued feedback from the community 2018-08-03 18:02:38 -04:00
thepudds
e4e6f40d10 clarified historical point about initial vgo behavior regarding v2+ tags 2018-08-03 17:43:44 -04:00
thepudds
ca4878df3e smaller wording improvement in 'Version Selection' section 2018-08-03 13:06:14 -04:00
thepudds
c164d5a79b add a simple example to the 'Version Selection' section 2018-08-03 13:04:28 -04:00
thepudds
501c4657ed tweaked section on 'Changes Since the Initial Vgo Proposal'; simplified 'Version Selection' section slightly 2018-08-03 09:24:53 -04:00
thepudds
1212ced86b minor clarification to an older sentence in 'Semantic Import Versioning' section 2018-08-03 00:29:50 -04:00
thepudds
3a0fa57ea4 another minor tweak to 'Version Selection' section 2018-08-03 00:20:31 -04:00
thepudds
83735ebc8b one more tweak to 'Version selection' section 2018-08-02 23:59:42 -04:00
thepudds
91ffcea301 tweak the 'Version Selection' section 2018-08-02 23:55:11 -04:00
thepudds
e4474f27bb hopefully final tweak to TOC 2018-08-02 22:26:17 -04:00
thepudds
0168d01705 adjust table of contents and some links; minor tweaks to list of post-proposal changes 2018-08-02 22:24:15 -04:00
thepudds
fc0364b17f added Table of Contents (slightly odd placement of TOC in an attempt to keep 'Current Status' section or at least its heading above the fold); tweaked my list of post-vgo-proposal changes 2018-08-02 22:10:15 -04:00
thepudds
889196471f use "How to..." for the three main how to sections; prepare for table of contents; update order of some of the bottom sections; 2018-08-02 21:51:04 -04:00
thepudds
7c6483c5b9 flip the order of the two options for creating a /v2+ module. (I've seen predictions that the /v2+ directory-based approach will be less common, though I guess we'll see what the future brings) 2018-08-02 21:24:27 -04:00
thepudds
01d386c23f one more tweak to 'Version selection' section 2018-08-02 09:48:29 -04:00
thepudds
d9442593f8 small adjustments to the 'Version selection' section and 'How are versions marked as incompatible' section 2018-08-02 09:44:49 -04:00
thepudds
5852af34b9 small tweak to 'full module path' examples to make it slightly easier to scan (e.g., changed 'pkg1' -> 'pkg' given there are already many numbers in the example) 2018-08-02 09:14:58 -04:00
thepudds
5077edf9f7 moved older text about allowing a v1 module to be implemented in terms of its v2 replacement to the 'Major Versions' section, and some small related edits to 'Major Versions' section 2018-08-02 09:01:12 -04:00
thepudds
5af74dbfc9 briefly introduce MVS, but point to the proposal and initial vgo blog series for details; mention the latest version is selected for new direct dependencies; add some additional pointers; remove the 'for now' from the section on semantic import versioning (I'm guessing that was written a while ago); other minor text cleanup 2018-08-01 18:14:36 -04:00
thepudds
c951cc8e98 clarify 'go test all' slightly; slightly improve 'go get -u' bullets 2018-08-01 09:43:54 -04:00
thepudds
8f75c6cbd8 place slightly more emphasis on a couple pointers to tip documentation 2018-08-01 09:18:37 -04:00
thepudds
acb0f90328 minor wording tweak 2018-08-01 04:12:54 -04:00