WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 81102aa

Browse files
Banner Schaferarschles
authored andcommitted
Explain vendor vs proxy (#1403)
* adding a section for discussion on when to do vendor directories vs. when to use athens or another proxy server * adding more detail and an outline * Adding a bit more 😄 * adding to vendor vs athens faq * removing reference material from FAQ when to use Athens * Fixing awkward phrasing in faq docs.
1 parent 790c745 commit 81102aa

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/content/faq.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,23 @@ Which currently includes:
8787
- hg
8888
- bzr
8989
- fossil
90+
91+
### When should I use a vendor directory, and when should I use Athens?
92+
93+
The Go community has used vendor directories for a long time before module proxies like Athens came along, so naturally each group collaborating on code should decide for themselves whether they want to use a vendor directory, use Athens, or do both!
94+
95+
Using a vendor directory (without a proxy) is valuable when:
96+
97+
- CI/CD systems don't have access to an Athens (even if it's internal)
98+
- When the vendor directory is so small that it is still faster to check it out from a repo than it is to pull zip files from the server
99+
- If you're coming from glide/dep or another dependency management system that leveraged the vendor directory
100+
101+
Athens (without a vendor directory) is valuable when:
102+
103+
- You have a new project
104+
- Your team requires that you use Athens (i.e. for isolation or dependency auditing)
105+
- Your vendor directory is large and causing slow checkouts and downloading from Athens speeds the build up
106+
- For developers slow checkouts will not be as much of a problem as for ci tools which frequently need to checkout fresh copies of the project
107+
- You want to remove the vendor directory from your project to:
108+
- Reduce noise in pull requests
109+
- Reduce difficulty doing fuzzy file searching in your project

0 commit comments

Comments
 (0)