go/README.md - Issue 2071243002: infra/go: Adding setup instructions and quick setup script.

Side by Side Diff: go/README.md

Issue 2071243002: infra/go: Adding setup instructions and quick setup script. (Closed) Base URL: https://chromium.googlesource.com/infra/infra.git@master

Patch Set: Created 4 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

OLD	NEW
1 # Chromium Infra Go Area	1 # Chromium Infra Go Area

2	2

3 [TOC]	3 [TOC]

4	4

	5 ## Get the code

	6

	7 The steps for getting the code are;
	Eric Burnett 2016/06/17 17:23:30 ';' -> ':' ';' -> ':' mithro 2016/06/18 07:13:17 Done. Show quoted text On 2016/06/17 17:23:30, Eric Burnett wrote: > ';' -> ':' Done.
	8

	9 1) [Install depot_tools](https://www.chromium.org/developers/how-tos/install-de pot-tools)

	10 1) Run `fetch infra`

	11 1) Run `infra/go/env.py`

	12

	13 ### Quick Setup
	tandrii(chromium) 2016/06/17 09:28:44 s/Quick Setup/I just want to start coding (aka i s/Quick Setup/I just want to start coding (aka i just want to serve 5TB) mithro 2016/06/18 07:13:17 "I just want to start coding" looks weird in the T Show quoted text On 2016/06/17 09:28:44, tandrii(chromium) wrote: > s/Quick Setup/I just want to start coding > > (aka i just want to serve 5TB) "I just want to start coding" looks weird in the TOC....
	14

	15 If you are on Linux you can run the [quicksetup script](quicksetup.sh) like so;
	Eric Burnett 2016/06/17 17:23:31 ';' -> ':' ';' -> ':' mithro 2016/06/18 07:13:17 Done. Show quoted text On 2016/06/17 17:23:31, Eric Burnett wrote: > ';' -> ':' Done.
	16

	17 ```shell
	tandrii(chromium) 2016/06/17 09:28:44 This works fine for github flavor of MD, but I'm n This works fine for github flavor of MD, but I'm not sure about Gerrit. tandrii(chromium) 2016/06/17 09:39:21 It does work in Gerrit too: https://chromium.googl Show quoted text On 2016/06/17 09:28:44, tandrii(chromium) wrote: > This works fine for github flavor of MD, but I'm not sure about Gerrit. It does work in Gerrit too: https://chromium.googlesource.com/infra/infra/+/3b59c550ed9d6a1e73c9451bad5e8... (I've uploaded your CL to gerrit with "git cl upload --gerrit" https://chromium-review.googlesource.com/c/353571/) mithro 2016/06/18 07:13:17 Acknowledged. Show quoted text On 2016/06/17 09:28:44, tandrii(chromium) wrote: > This works fine for github flavor of MD, but I'm not sure about Gerrit. Acknowledged. mithro 2016/06/18 07:13:17 I can't actually see how you tell that it works in Show quoted text On 2016/06/17 09:39:21, tandrii(chromium) wrote: > On 2016/06/17 09:28:44, tandrii(chromium) wrote: > > This works fine for github flavor of MD, but I'm not sure about Gerrit. > > It does work in Gerrit too: > https://chromium.googlesource.com/infra/infra/+/3b59c550ed9d6a1e73c9451bad5e8... > (I've uploaded your CL to gerrit with "git cl upload --gerrit" > https://chromium-review.googlesource.com/c/353571/) I can't actually see how you tell that it works in that interface?
	18 cd /where/you/want/source/code

	19 wget -O- "https://chromium.googlesource.com/infra/infra/+/master/go/quicksetup.s h?format=TEXT" \| bash
	Vadim Sh. 2016/06/17 17:38:46 format=TEXT actually returns base64 encoded text : format=TEXT actually returns base64 encoded text :-/ e.g. https://chromium.googlesource.com/infra/infra/+/master/go/check.py?format=TEXT (that's how Gerrit works around XSS possibility). mithro 2016/06/18 07:13:17 Luckily `base64` command exists. Added to the comm Show quoted text On 2016/06/17 17:38:46, Vadim Sh. wrote: > format=TEXT actually returns base64 encoded text :-/ > > e.g. > https://chromium.googlesource.com/infra/infra/+/master/go/check.py?format=TEXT > > (that's how Gerrit works around XSS possibility). Luckily `base64` command exists. Added to the command line.
	20 ```
	Eric Burnett 2016/06/17 17:23:31 Can you also add a comment explaining what this wi Can you also add a comment explaining what this will do? Something like: "This will create a self-contained cr-infra-go-area directory and populate it will all necessary tools and source for using or contributing to Chromium's Go Infrastructure. Once run, look in cr-infra-go-area/infra/go/src for the editable source code." mithro 2016/06/18 07:13:17 Done. Show quoted text On 2016/06/17 17:23:31, Eric Burnett wrote: > Can you also add a comment explaining what this will do? Something like: > > "This will create a self-contained cr-infra-go-area directory and populate it > will all necessary tools and source for using or contributing to Chromium's Go > Infrastructure. Once run, look in cr-infra-go-area/infra/go/src for the editable > source code." Done.
	21

5 ## Structure	22 ## Structure

6	23

7 This directory contains a set of scripts to setup and manage a hermetic Go	24 This directory contains a set of scripts to setup and manage a hermetic Go

8 building environment. We pin versions of the Go toolset and all third party	25 building environment. We pin versions of the Go toolset and all third party

9 dependencies that the infra code is using. It is important for getting	26 dependencies that the infra code is using. It is important for getting

10 non-flaky, reproducible builds of Go code on a CI and on developers' machines.	27 non-flaky, reproducible builds of Go code on a CI and on developers' machines.

11	28

12 Structurally `infra/go` represents two workspaces (two directories in	29 Structurally `infra/go` represents two workspaces (two directories in

13 `$GOPATH`):	30 `$GOPATH`):

14	31

(...skipping 132 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
147 Some Golang related packages are already on `*.googlesource.com` (though it may	164 Some Golang related packages are already on `*.googlesource.com` (though it may

148 be non obvious at the first glance). For example all `golang.org/x/*` ones are	165 be non obvious at the first glance). For example all `golang.org/x/*` ones are

149 actually served from `https://go.googlesource.com/`.	166 actually served from `https://go.googlesource.com/`.

150	167

151 `deps.py` will warn you if it sees a package being referenced from	168 `deps.py` will warn you if it sees a package being referenced from

152 a source-of-truth repo, and not a mirror.	169 a source-of-truth repo, and not a mirror.

153	170

154 If you are positive that a mirror is needed, file	171 If you are positive that a mirror is needed, file

155 [Infra-Git](https://bugs.chromium.org/p/chromium/issues/entry?template=Infra-Git )	172 [Infra-Git](https://bugs.chromium.org/p/chromium/issues/entry?template=Infra-Git )

156 ticket specifying what repository you need to be mirrored.	173 ticket specifying what repository you need to be mirrored.

OLD	NEW

« no previous file with comments | « no previous file | go/quicksetup.sh » ('j') | go/quicksetup.sh » ('J')