github.com/linapex/ethereum-dpos-chinese@v0.0.0-20190316121959-b78b3a4a1ece/build/ci.go (about)

     1  
     2  //<developer>
     3  //    <name>linapex 曹一峰</name>
     4  //    <email>linapex@163.com</email>
     5  //    <wx>superexc</wx>
     6  //    <qqgroup>128148617</qqgroup>
     7  //    <url>https://jsq.ink</url>
     8  //    <role>pku engineer</role>
     9  //    <date>2019-03-16 12:09:27</date>
    10  //</624342587410485248>
    11  
    12  
    13  //+不建
    14  
    15  /*
    16  从连续集成脚本调用CI命令。
    17  
    18  用法:go run build/ci.go<command>><command flags/arguments>
    19  
    20  可用命令包括:
    21  
    22     安装[-architecture][-cc compiler][packages…]——构建包和可执行文件
    23     测试[-coverage][packages…]——运行测试
    24     lint—运行某些预先选定的linter
    25     archive[-architecture][-type zip tar][-signer key envvar][-upload dest]--存档生成的工件
    26     importkeys—从env导入签名密钥
    27     debsrc[-signer key id][-upload dest]--创建Debian源包
    28     nsis--创建Windows nsis安装程序
    29     aar[-local][-sign key id][-deploy repo][-upload dest]--创建Android存档
    30     xcode[-local][-sign key id][-deploy repo][-upload dest]--创建iOS xcode框架
    31     xgo[-alltools][options]--根据选项交叉构建
    32     purge[-store blobstore][-days threshold]--从blobstore中清除旧存档
    33  
    34  对于所有命令,-n防止执行外部程序(干运行模式)。
    35  
    36  **/
    37  
    38  package main
    39  
    40  import (
    41  	"bufio"
    42  	"bytes"
    43  	"encoding/base64"
    44  	"flag"
    45  	"fmt"
    46  	"go/parser"
    47  	"go/token"
    48  	"io/ioutil"
    49  	"log"
    50  	"os"
    51  	"os/exec"
    52  	"path/filepath"
    53  	"regexp"
    54  	"runtime"
    55  	"strings"
    56  	"time"
    57  
    58  	"github.com/ethereum/go-ethereum/internal/build"
    59  	"github.com/ethereum/go-ethereum/params"
    60  	sv "github.com/ethereum/go-ethereum/swarm/version"
    61  )
    62  
    63  var (
    64  //最后出现在geth*.zip存档中的文件。
    65  	gethArchiveFiles = []string{
    66  		"COPYING",
    67  		executablePath("geth"),
    68  	}
    69  
    70  //最后出现在geth alltools*.zip存档中的文件。
    71  	allToolsArchiveFiles = []string{
    72  		"COPYING",
    73  		executablePath("abigen"),
    74  		executablePath("bootnode"),
    75  		executablePath("evm"),
    76  		executablePath("geth"),
    77  		executablePath("puppeth"),
    78  		executablePath("rlpdump"),
    79  		executablePath("wnode"),
    80  	}
    81  
    82  //最后出现在swarm.zip文件中的文件。
    83  	swarmArchiveFiles = []string{
    84  		"COPYING",
    85  		executablePath("swarm"),
    86  	}
    87  
    88  //为此处列出的所有可执行文件创建Debian包。
    89  	debExecutables = []debExecutable{
    90  		{
    91  			BinaryName:  "abigen",
    92  			Description: "Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages.",
    93  		},
    94  		{
    95  			BinaryName:  "bootnode",
    96  			Description: "Ethereum bootnode.",
    97  		},
    98  		{
    99  			BinaryName:  "evm",
   100  			Description: "Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode.",
   101  		},
   102  		{
   103  			BinaryName:  "geth",
   104  			Description: "Ethereum CLI client.",
   105  		},
   106  		{
   107  			BinaryName:  "puppeth",
   108  			Description: "Ethereum private network manager.",
   109  		},
   110  		{
   111  			BinaryName:  "rlpdump",
   112  			Description: "Developer utility tool that prints RLP structures.",
   113  		},
   114  		{
   115  			BinaryName:  "wnode",
   116  			Description: "Ethereum Whisper diagnostic tool",
   117  		},
   118  	}
   119  
   120  //为此处列出的所有可执行文件创建Debian包。
   121  	debSwarmExecutables = []debExecutable{
   122  		{
   123  			BinaryName:  "swarm",
   124  			PackageName: "ethereum-swarm",
   125  			Description: "Ethereum Swarm daemon and tools",
   126  		},
   127  	}
   128  
   129  	debEthereum = debPackage{
   130  		Name:        "ethereum",
   131  		Version:     params.Version,
   132  		Executables: debExecutables,
   133  	}
   134  
   135  	debSwarm = debPackage{
   136  		Name:        "ethereum-swarm",
   137  		Version:     sv.Version,
   138  		Executables: debSwarmExecutables,
   139  	}
   140  
   141  //Debian元软件包,用于构建和推送到Ubuntu PPA
   142  	debPackages = []debPackage{
   143  		debSwarm,
   144  		debEthereum,
   145  	}
   146  
   147  //要由xgo命令交叉编译的包
   148  	allCrossCompiledArchiveFiles = append(allToolsArchiveFiles, swarmArchiveFiles...)
   149  
   150  //为其创建包的发行版。
   151  //注:Vivid不支持,因为它没有Golang-1.6包。
   152  //注意:不支持wily,因为它在lanchpad上被正式否决。
   153  //注意:不支持Yakkety,因为它在Lanchpad上被正式否决。
   154  //注意:不支持Zesty,因为它在LanchPad上被正式否决。
   155  //注意:不支持Artful,因为它在Lanchpad上被正式否决。
   156  	debDistros = []string{"trusty", "xenial", "bionic", "cosmic"}
   157  )
   158  
   159  var GOBIN, _ = filepath.Abs(filepath.Join("build", "bin"))
   160  
   161  func executablePath(name string) string {
   162  	if runtime.GOOS == "windows" {
   163  		name += ".exe"
   164  	}
   165  	return filepath.Join(GOBIN, name)
   166  }
   167  
   168  func main() {
   169  	log.SetFlags(log.Lshortfile)
   170  
   171  	if _, err := os.Stat(filepath.Join("build", "ci.go")); os.IsNotExist(err) {
   172  		log.Fatal("this script must be run from the root of the repository")
   173  	}
   174  	if len(os.Args) < 2 {
   175  		log.Fatal("need subcommand as first argument")
   176  	}
   177  	switch os.Args[1] {
   178  	case "install":
   179  		doInstall(os.Args[2:])
   180  	case "test":
   181  		doTest(os.Args[2:])
   182  	case "lint":
   183  		doLint(os.Args[2:])
   184  	case "archive":
   185  		doArchive(os.Args[2:])
   186  	case "debsrc":
   187  		doDebianSource(os.Args[2:])
   188  	case "nsis":
   189  		doWindowsInstaller(os.Args[2:])
   190  	case "aar":
   191  		doAndroidArchive(os.Args[2:])
   192  	case "xcode":
   193  		doXCodeFramework(os.Args[2:])
   194  	case "xgo":
   195  		doXgo(os.Args[2:])
   196  	case "purge":
   197  		doPurge(os.Args[2:])
   198  	default:
   199  		log.Fatal("unknown command ", os.Args[1])
   200  	}
   201  }
   202  
   203  //编译
   204  
   205  func doInstall(cmdline []string) {
   206  	var (
   207  		arch = flag.String("arch", "", "Architecture to cross build for")
   208  		cc   = flag.String("cc", "", "C compiler to cross build with")
   209  	)
   210  	flag.CommandLine.Parse(cmdline)
   211  	env := build.Env()
   212  
   213  //检查Go版本。人们经常公开关于汇编的问题
   214  //落伍失败。这样可以省去他们的麻烦。
   215  	if !strings.Contains(runtime.Version(), "devel") {
   216  //由于无法进行文本比较,因此请计算次要版本号(1.10<1.9)
   217  		var minor int
   218  		fmt.Sscanf(strings.TrimPrefix(runtime.Version(), "go1."), "%d", &minor)
   219  
   220  		if minor < 9 {
   221  			log.Println("You have Go version", runtime.Version())
   222  			log.Println("go-ethereum requires at least Go version 1.9 and cannot")
   223  			log.Println("be compiled with an earlier version. Please upgrade your Go installation.")
   224  			os.Exit(1)
   225  		}
   226  	}
   227  //编译作为参数提供的包,如果没有参数,则编译所有内容。
   228  	packages := []string{"./..."}
   229  	if flag.NArg() > 0 {
   230  		packages = flag.Args()
   231  	}
   232  	packages = build.ExpandPackagesNoVendor(packages)
   233  
   234  	if *arch == "" || *arch == runtime.GOARCH {
   235  		goinstall := goTool("install", buildFlags(env)...)
   236  		goinstall.Args = append(goinstall.Args, "-v")
   237  		goinstall.Args = append(goinstall.Args, packages...)
   238  		build.MustRun(goinstall)
   239  		return
   240  	}
   241  //如果我们交叉编译到armv5 armv6或armv7,请清除以前的任何版本。
   242  	if *arch == "arm" {
   243  		os.RemoveAll(filepath.Join(runtime.GOROOT(), "pkg", runtime.GOOS+"_arm"))
   244  		for _, path := range filepath.SplitList(build.GOPATH()) {
   245  			os.RemoveAll(filepath.Join(path, "pkg", runtime.GOOS+"_arm"))
   246  		}
   247  	}
   248  //看来我们是在交叉编译,围绕禁地工作
   249  	goinstall := goToolArch(*arch, *cc, "install", buildFlags(env)...)
   250  	goinstall.Args = append(goinstall.Args, "-v")
   251  	goinstall.Args = append(goinstall.Args, []string{"-buildmode", "archive"}...)
   252  	goinstall.Args = append(goinstall.Args, packages...)
   253  	build.MustRun(goinstall)
   254  
   255  	if cmds, err := ioutil.ReadDir("cmd"); err == nil {
   256  		for _, cmd := range cmds {
   257  			pkgs, err := parser.ParseDir(token.NewFileSet(), filepath.Join(".", "cmd", cmd.Name()), nil, parser.PackageClauseOnly)
   258  			if err != nil {
   259  				log.Fatal(err)
   260  			}
   261  			for name := range pkgs {
   262  				if name == "main" {
   263  					gobuild := goToolArch(*arch, *cc, "build", buildFlags(env)...)
   264  					gobuild.Args = append(gobuild.Args, "-v")
   265  					gobuild.Args = append(gobuild.Args, []string{"-o", executablePath(cmd.Name())}...)
   266  					gobuild.Args = append(gobuild.Args, "."+string(filepath.Separator)+filepath.Join("cmd", cmd.Name()))
   267  					build.MustRun(gobuild)
   268  					break
   269  				}
   270  			}
   271  		}
   272  	}
   273  }
   274  
   275  func buildFlags(env build.Environment) (flags []string) {
   276  	var ld []string
   277  	if env.Commit != "" {
   278  		ld = append(ld, "-X", "main.gitCommit="+env.Commit)
   279  	}
   280  	if runtime.GOOS == "darwin" {
   281  		ld = append(ld, "-s")
   282  	}
   283  
   284  	if len(ld) > 0 {
   285  		flags = append(flags, "-ldflags", strings.Join(ld, " "))
   286  	}
   287  	return flags
   288  }
   289  
   290  func goTool(subcmd string, args ...string) *exec.Cmd {
   291  	return goToolArch(runtime.GOARCH, os.Getenv("CC"), subcmd, args...)
   292  }
   293  
   294  func goToolArch(arch string, cc string, subcmd string, args ...string) *exec.Cmd {
   295  	cmd := build.GoTool(subcmd, args...)
   296  	cmd.Env = []string{"GOPATH=" + build.GOPATH()}
   297  	if arch == "" || arch == runtime.GOARCH {
   298  		cmd.Env = append(cmd.Env, "GOBIN="+GOBIN)
   299  	} else {
   300  		cmd.Env = append(cmd.Env, "CGO_ENABLED=1")
   301  		cmd.Env = append(cmd.Env, "GOARCH="+arch)
   302  	}
   303  	if cc != "" {
   304  		cmd.Env = append(cmd.Env, "CC="+cc)
   305  	}
   306  	for _, e := range os.Environ() {
   307  		if strings.HasPrefix(e, "GOPATH=") || strings.HasPrefix(e, "GOBIN=") {
   308  			continue
   309  		}
   310  		cmd.Env = append(cmd.Env, e)
   311  	}
   312  	return cmd
   313  }
   314  
   315  //运行测试
   316  //
   317  //“测试”还包括静态分析工具,如vet。
   318  
   319  func doTest(cmdline []string) {
   320  	var (
   321  		coverage = flag.Bool("coverage", false, "Whether to record code coverage")
   322  	)
   323  	flag.CommandLine.Parse(cmdline)
   324  	env := build.Env()
   325  
   326  	packages := []string{"./..."}
   327  	if len(flag.CommandLine.Args()) > 0 {
   328  		packages = flag.CommandLine.Args()
   329  	}
   330  	packages = build.ExpandPackagesNoVendor(packages)
   331  
   332  //在测试之前运行分析工具。
   333  	build.MustRun(goTool("vet", packages...))
   334  
   335  //运行实际测试。
   336  	gotest := goTool("test", buildFlags(env)...)
   337  //一次测试一个包。CI建设者很慢
   338  //一些测试在负载下会超时。
   339  	gotest.Args = append(gotest.Args, "-p", "1")
   340  	if *coverage {
   341  		gotest.Args = append(gotest.Args, "-covermode=atomic", "-cover")
   342  	}
   343  
   344  	gotest.Args = append(gotest.Args, packages...)
   345  	build.MustRun(gotest)
   346  }
   347  
   348  //在请求的包上运行gometalinter
   349  func doLint(cmdline []string) {
   350  	flag.CommandLine.Parse(cmdline)
   351  
   352  	packages := []string{"./..."}
   353  	if len(flag.CommandLine.Args()) > 0 {
   354  		packages = flag.CommandLine.Args()
   355  	}
   356  //获取metallinter并安装所有支持的过梁
   357  	build.MustRun(goTool("get", "gopkg.in/alecthomas/gometalinter.v2"))
   358  	build.MustRunCommand(filepath.Join(GOBIN, "gometalinter.v2"), "--install")
   359  
   360  //一起运行快速过梁
   361  	configs := []string{
   362  		"--vendor",
   363  		"--tests",
   364  		"--deadline=2m",
   365  		"--disable-all",
   366  		"--enable=goimports",
   367  		"--enable=varcheck",
   368  		"--enable=vet",
   369  		"--enable=gofmt",
   370  		"--enable=misspell",
   371  		"--enable=goconst",
   372  "--min-occurrences=6", //为GOCOST
   373  	}
   374  	build.MustRunCommand(filepath.Join(GOBIN, "gometalinter.v2"), append(configs, packages...)...)
   375  
   376  //一个接一个地运行缓慢的过梁
   377  	for _, linter := range []string{"unconvert", "gosimple"} {
   378  		configs = []string{"--vendor", "--tests", "--deadline=10m", "--disable-all", "--enable=" + linter}
   379  		build.MustRunCommand(filepath.Join(GOBIN, "gometalinter.v2"), append(configs, packages...)...)
   380  	}
   381  }
   382  
   383  //释放包装
   384  func doArchive(cmdline []string) {
   385  	var (
   386  		arch   = flag.String("arch", runtime.GOARCH, "Architecture cross packaging")
   387  		atype  = flag.String("type", "zip", "Type of archive to write (zip|tar)")
   388  		signer = flag.String("signer", "", `Environment variable holding the signing key (e.g. LINUX_SIGNING_KEY)`)
   389  		upload = flag.String("upload", "", `Destination to upload the archives (usually "gethstore/builds")`)
   390  		ext    string
   391  	)
   392  	flag.CommandLine.Parse(cmdline)
   393  	switch *atype {
   394  	case "zip":
   395  		ext = ".zip"
   396  	case "tar":
   397  		ext = ".tar.gz"
   398  	default:
   399  		log.Fatal("unknown archive type: ", atype)
   400  	}
   401  
   402  	var (
   403  		env = build.Env()
   404  
   405  		basegeth = archiveBasename(*arch, params.ArchiveVersion(env.Commit))
   406  		geth     = "geth-" + basegeth + ext
   407  		alltools = "geth-alltools-" + basegeth + ext
   408  
   409  		baseswarm = archiveBasename(*arch, sv.ArchiveVersion(env.Commit))
   410  		swarm     = "swarm-" + baseswarm + ext
   411  	)
   412  	maybeSkipArchive(env)
   413  	if err := build.WriteArchive(geth, gethArchiveFiles); err != nil {
   414  		log.Fatal(err)
   415  	}
   416  	if err := build.WriteArchive(alltools, allToolsArchiveFiles); err != nil {
   417  		log.Fatal(err)
   418  	}
   419  	if err := build.WriteArchive(swarm, swarmArchiveFiles); err != nil {
   420  		log.Fatal(err)
   421  	}
   422  	for _, archive := range []string{geth, alltools, swarm} {
   423  		if err := archiveUpload(archive, *upload, *signer); err != nil {
   424  			log.Fatal(err)
   425  		}
   426  	}
   427  }
   428  
   429  func archiveBasename(arch string, archiveVersion string) string {
   430  	platform := runtime.GOOS + "-" + arch
   431  	if arch == "arm" {
   432  		platform += os.Getenv("GOARM")
   433  	}
   434  	if arch == "android" {
   435  		platform = "android-all"
   436  	}
   437  	if arch == "ios" {
   438  		platform = "ios-all"
   439  	}
   440  	return platform + "-" + archiveVersion
   441  }
   442  
   443  func archiveUpload(archive string, blobstore string, signer string) error {
   444  //如果请求签名,则生成签名文件
   445  	if signer != "" {
   446  		pgpkey, err := base64.StdEncoding.DecodeString(os.Getenv(signer))
   447  		if err != nil {
   448  			return fmt.Errorf("invalid base64 %s", signer)
   449  		}
   450  		if err := build.PGPSignFile(archive, archive+".asc", string(pgpkey)); err != nil {
   451  			return err
   452  		}
   453  	}
   454  //如果请求上载到Azure,则可能使用其签名推送存档
   455  	if blobstore != "" {
   456  		auth := build.AzureBlobstoreConfig{
   457  			Account:   strings.Split(blobstore, "/")[0],
   458  			Token:     os.Getenv("AZURE_BLOBSTORE_TOKEN"),
   459  			Container: strings.SplitN(blobstore, "/", 2)[1],
   460  		}
   461  		if err := build.AzureBlobstoreUpload(archive, filepath.Base(archive), auth); err != nil {
   462  			return err
   463  		}
   464  		if signer != "" {
   465  			if err := build.AzureBlobstoreUpload(archive+".asc", filepath.Base(archive+".asc"), auth); err != nil {
   466  				return err
   467  			}
   468  		}
   469  	}
   470  	return nil
   471  }
   472  
   473  //跳过某些生成配置的存档。
   474  func maybeSkipArchive(env build.Environment) {
   475  	if env.IsPullRequest {
   476  		log.Printf("skipping because this is a PR build")
   477  		os.Exit(0)
   478  	}
   479  	if env.IsCronJob {
   480  		log.Printf("skipping because this is a cron job")
   481  		os.Exit(0)
   482  	}
   483  	if env.Branch != "master" && !strings.HasPrefix(env.Tag, "v1.") {
   484  		log.Printf("skipping because branch %q, tag %q is not on the whitelist", env.Branch, env.Tag)
   485  		os.Exit(0)
   486  	}
   487  }
   488  
   489  //Debian包装
   490  func doDebianSource(cmdline []string) {
   491  	var (
   492  		signer  = flag.String("signer", "", `Signing key name, also used as package author`)
   493  		upload  = flag.String("upload", "", `Where to upload the source package (usually "ppa:ethereum/ethereum")`)
   494  		workdir = flag.String("workdir", "", `Output directory for packages (uses temp dir if unset)`)
   495  		now     = time.Now()
   496  	)
   497  	flag.CommandLine.Parse(cmdline)
   498  	*workdir = makeWorkdir(*workdir)
   499  	env := build.Env()
   500  	maybeSkipArchive(env)
   501  
   502  //导入签名密钥。
   503  	if b64key := os.Getenv("PPA_SIGNING_KEY"); b64key != "" {
   504  		key, err := base64.StdEncoding.DecodeString(b64key)
   505  		if err != nil {
   506  			log.Fatal("invalid base64 PPA_SIGNING_KEY")
   507  		}
   508  		gpg := exec.Command("gpg", "--import")
   509  		gpg.Stdin = bytes.NewReader(key)
   510  		build.MustRun(gpg)
   511  	}
   512  
   513  //创建Debian包并上载它们
   514  	for _, pkg := range debPackages {
   515  		for _, distro := range debDistros {
   516  			meta := newDebMetadata(distro, *signer, env, now, pkg.Name, pkg.Version, pkg.Executables)
   517  			pkgdir := stageDebianSource(*workdir, meta)
   518  			debuild := exec.Command("debuild", "-S", "-sa", "-us", "-uc")
   519  			debuild.Dir = pkgdir
   520  			build.MustRun(debuild)
   521  
   522  			changes := fmt.Sprintf("%s_%s_source.changes", meta.Name(), meta.VersionString())
   523  			changes = filepath.Join(*workdir, changes)
   524  			if *signer != "" {
   525  				build.MustRunCommand("debsign", changes)
   526  			}
   527  			if *upload != "" {
   528  				build.MustRunCommand("dput", *upload, changes)
   529  			}
   530  		}
   531  	}
   532  }
   533  
   534  func makeWorkdir(wdflag string) string {
   535  	var err error
   536  	if wdflag != "" {
   537  		err = os.MkdirAll(wdflag, 0744)
   538  	} else {
   539  		wdflag, err = ioutil.TempDir("", "geth-build-")
   540  	}
   541  	if err != nil {
   542  		log.Fatal(err)
   543  	}
   544  	return wdflag
   545  }
   546  
   547  func isUnstableBuild(env build.Environment) bool {
   548  	if env.Tag != "" {
   549  		return false
   550  	}
   551  	return true
   552  }
   553  
   554  type debPackage struct {
   555  Name        string          //要生成的Debian包的名称,例如“以太坊”或“以太坊群”
   556  Version     string          //debpackage的干净版本,例如1.8.12或0.3.0,没有任何元数据
   557  Executables []debExecutable //要包含在包中的可执行文件
   558  }
   559  
   560  type debMetadata struct {
   561  	Env build.Environment
   562  
   563  	PackageName string
   564  
   565  //进入正在构建的以太坊版本。注意这个
   566  //不是Debian包版本。包版本
   567  //由versionString构造。
   568  	Version string
   569  
   570  Author       string //“name<email>”,同时选择签名密钥
   571  	Distro, Time string
   572  	Executables  []debExecutable
   573  }
   574  
   575  type debExecutable struct {
   576  	PackageName string
   577  	BinaryName  string
   578  	Description string
   579  }
   580  
   581  //package返回包的名称(如果存在),或者
   582  //回退到BinaryName
   583  func (d debExecutable) Package() string {
   584  	if d.PackageName != "" {
   585  		return d.PackageName
   586  	}
   587  	return d.BinaryName
   588  }
   589  
   590  func newDebMetadata(distro, author string, env build.Environment, t time.Time, name string, version string, exes []debExecutable) debMetadata {
   591  	if author == "" {
   592  //没有签名密钥,请使用默认作者。
   593  		author = "Ethereum Builds <fjl@ethereum.org>"
   594  	}
   595  	return debMetadata{
   596  		PackageName: name,
   597  		Env:         env,
   598  		Author:      author,
   599  		Distro:      distro,
   600  		Version:     version,
   601  		Time:        t.Format(time.RFC1123Z),
   602  		Executables: exes,
   603  	}
   604  }
   605  
   606  //name返回依赖于
   607  //在所有可执行包上。
   608  func (meta debMetadata) Name() string {
   609  	if isUnstableBuild(meta.Env) {
   610  		return meta.PackageName + "-unstable"
   611  	}
   612  	return meta.PackageName
   613  }
   614  
   615  //versionString返回包的Debian版本。
   616  func (meta debMetadata) VersionString() string {
   617  	vsn := meta.Version
   618  	if meta.Env.Buildnum != "" {
   619  		vsn += "+build" + meta.Env.Buildnum
   620  	}
   621  	if meta.Distro != "" {
   622  		vsn += "+" + meta.Distro
   623  	}
   624  	return vsn
   625  }
   626  
   627  //exelist返回所有可执行包的列表。
   628  func (meta debMetadata) ExeList() string {
   629  	names := make([]string, len(meta.Executables))
   630  	for i, e := range meta.Executables {
   631  		names[i] = meta.ExeName(e)
   632  	}
   633  	return strings.Join(names, ", ")
   634  }
   635  
   636  //exename返回可执行包的包名称。
   637  func (meta debMetadata) ExeName(exe debExecutable) string {
   638  	if isUnstableBuild(meta.Env) {
   639  		return exe.Package() + "-unstable"
   640  	}
   641  	return exe.Package()
   642  }
   643  
   644  //execonflicts返回conflicts字段的内容
   645  //对于可执行包。
   646  func (meta debMetadata) ExeConflicts(exe debExecutable) string {
   647  	if isUnstableBuild(meta.Env) {
   648  //设置冲突列表,以便*-不稳定的包
   649  //不能与常规版本一起安装。
   650  //
   651  //https://www.debian.org/doc/debian-policy/ch-relationships.html网站
   652  //对冲突非常明确:并说应该
   653  //首选,冲突文件应通过
   654  //交替。我们最终可能会这样做,但使用冲突是
   655  //现在更容易了。
   656  		return "ethereum, " + exe.Package()
   657  	}
   658  	return ""
   659  }
   660  
   661  func stageDebianSource(tmpdir string, meta debMetadata) (pkgdir string) {
   662  	pkg := meta.Name() + "-" + meta.VersionString()
   663  	pkgdir = filepath.Join(tmpdir, pkg)
   664  	if err := os.Mkdir(pkgdir, 0755); err != nil {
   665  		log.Fatal(err)
   666  	}
   667  
   668  //复制源代码。
   669  	build.MustRunCommand("git", "checkout-index", "-a", "--prefix", pkgdir+string(filepath.Separator))
   670  
   671  //将Debian构建文件放置到位。
   672  	debian := filepath.Join(pkgdir, "debian")
   673  	build.Render("build/deb/"+meta.PackageName+"/deb.rules", filepath.Join(debian, "rules"), 0755, meta)
   674  	build.Render("build/deb/"+meta.PackageName+"/deb.changelog", filepath.Join(debian, "changelog"), 0644, meta)
   675  	build.Render("build/deb/"+meta.PackageName+"/deb.control", filepath.Join(debian, "control"), 0644, meta)
   676  	build.Render("build/deb/"+meta.PackageName+"/deb.copyright", filepath.Join(debian, "copyright"), 0644, meta)
   677  	build.RenderString("8\n", filepath.Join(debian, "compat"), 0644, meta)
   678  	build.RenderString("3.0 (native)\n", filepath.Join(debian, "source/format"), 0644, meta)
   679  	for _, exe := range meta.Executables {
   680  		install := filepath.Join(debian, meta.ExeName(exe)+".install")
   681  		docs := filepath.Join(debian, meta.ExeName(exe)+".docs")
   682  		build.Render("build/deb/"+meta.PackageName+"/deb.install", install, 0644, exe)
   683  		build.Render("build/deb/"+meta.PackageName+"/deb.docs", docs, 0644, exe)
   684  	}
   685  
   686  	return pkgdir
   687  }
   688  
   689  //Windows安装程序
   690  func doWindowsInstaller(cmdline []string) {
   691  //分析标志并在prs上生成跳过安装程序
   692  	var (
   693  		arch    = flag.String("arch", runtime.GOARCH, "Architecture for cross build packaging")
   694  		signer  = flag.String("signer", "", `Environment variable holding the signing key (e.g. WINDOWS_SIGNING_KEY)`)
   695  		upload  = flag.String("upload", "", `Destination to upload the archives (usually "gethstore/builds")`)
   696  		workdir = flag.String("workdir", "", `Output directory for packages (uses temp dir if unset)`)
   697  	)
   698  	flag.CommandLine.Parse(cmdline)
   699  	*workdir = makeWorkdir(*workdir)
   700  	env := build.Env()
   701  	maybeSkipArchive(env)
   702  
   703  //安装程序中包含的聚合二进制文件
   704  	var (
   705  		devTools []string
   706  		allTools []string
   707  		gethTool string
   708  	)
   709  	for _, file := range allToolsArchiveFiles {
   710  if file == "COPYING" { //许可证,稍后复制
   711  			continue
   712  		}
   713  		allTools = append(allTools, filepath.Base(file))
   714  		if filepath.Base(file) == "geth.exe" {
   715  			gethTool = file
   716  		} else {
   717  			devTools = append(devTools, file)
   718  		}
   719  	}
   720  
   721  //呈现NSI脚本:安装程序NSI包含两个安装程序部分,
   722  //第一部分包含geth二进制文件,第二部分包含dev工具。
   723  	templateData := map[string]interface{}{
   724  		"License":  "COPYING",
   725  		"Geth":     gethTool,
   726  		"DevTools": devTools,
   727  	}
   728  	build.Render("build/nsis.geth.nsi", filepath.Join(*workdir, "geth.nsi"), 0644, nil)
   729  	build.Render("build/nsis.install.nsh", filepath.Join(*workdir, "install.nsh"), 0644, templateData)
   730  	build.Render("build/nsis.uninstall.nsh", filepath.Join(*workdir, "uninstall.nsh"), 0644, allTools)
   731  	build.Render("build/nsis.pathupdate.nsh", filepath.Join(*workdir, "PathUpdate.nsh"), 0644, nil)
   732  	build.Render("build/nsis.envvarupdate.nsh", filepath.Join(*workdir, "EnvVarUpdate.nsh"), 0644, nil)
   733  	build.CopyFile(filepath.Join(*workdir, "SimpleFC.dll"), "build/nsis.simplefc.dll", 0755)
   734  	build.CopyFile(filepath.Join(*workdir, "COPYING"), "COPYING", 0755)
   735  
   736  //构建安装程序。这假设所有需要的文件以前
   737  //构建(不要混合构建和打包以保持交叉编译的复杂性
   738  //最低限度)。
   739  	version := strings.Split(params.Version, ".")
   740  	if env.Commit != "" {
   741  		version[2] += "-" + env.Commit[:8]
   742  	}
   743  	installer, _ := filepath.Abs("geth-" + archiveBasename(*arch, params.ArchiveVersion(env.Commit)) + ".exe")
   744  	build.MustRunCommand("makensis.exe",
   745  		"/DOUTPUTFILE="+installer,
   746  		"/DMAJORVERSION="+version[0],
   747  		"/DMINORVERSION="+version[1],
   748  		"/DBUILDVERSION="+version[2],
   749  		"/DARCH="+*arch,
   750  		filepath.Join(*workdir, "geth.nsi"),
   751  	)
   752  
   753  //签署并发布安装程序。
   754  	if err := archiveUpload(installer, *upload, *signer); err != nil {
   755  		log.Fatal(err)
   756  	}
   757  }
   758  
   759  //Android档案
   760  
   761  func doAndroidArchive(cmdline []string) {
   762  	var (
   763  		local  = flag.Bool("local", false, `Flag whether we're only doing a local build (skip Maven artifacts)`)
   764  		signer = flag.String("signer", "", `Environment variable holding the signing key (e.g. ANDROID_SIGNING_KEY)`)
   765  deploy = flag.String("deploy", "", `Destination to deploy the archive (usually "https://oss.sonatype.org”)`)
   766  		upload = flag.String("upload", "", `Destination to upload the archive (usually "gethstore/builds")`)
   767  	)
   768  	flag.CommandLine.Parse(cmdline)
   769  	env := build.Env()
   770  
   771  //健全性检查sdk和ndk是否已安装和设置
   772  	if os.Getenv("ANDROID_HOME") == "" {
   773  		log.Fatal("Please ensure ANDROID_HOME points to your Android SDK")
   774  	}
   775  	if os.Getenv("ANDROID_NDK") == "" {
   776  		log.Fatal("Please ensure ANDROID_NDK points to your Android NDK")
   777  	}
   778  //构建Android存档和Maven资源
   779  	build.MustRun(goTool("get", "golang.org/x/mobile/cmd/gomobile", "golang.org/x/mobile/cmd/gobind"))
   780  	build.MustRun(gomobileTool("init", "--ndk", os.Getenv("ANDROID_NDK")))
   781  	build.MustRun(gomobileTool("bind", "-ldflags", "-s -w", "--target", "android", "--javapkg", "org.ethereum", "-v", "github.com/ethereum/go-ethereum/mobile"))
   782  
   783  	if *local {
   784  //如果我们在本地构建,请将bundle复制到build dir并跳过maven
   785  		os.Rename("geth.aar", filepath.Join(GOBIN, "geth.aar"))
   786  		return
   787  	}
   788  	meta := newMavenMetadata(env)
   789  	build.Render("build/mvn.pom", meta.Package+".pom", 0755, meta)
   790  
   791  //跳过Maven Deploy和Azure上载以进行pr生成
   792  	maybeSkipArchive(env)
   793  
   794  //签名并将存档上载到Azure
   795  	archive := "geth-" + archiveBasename("android", params.ArchiveVersion(env.Commit)) + ".aar"
   796  	os.Rename("geth.aar", archive)
   797  
   798  	if err := archiveUpload(archive, *upload, *signer); err != nil {
   799  		log.Fatal(err)
   800  	}
   801  //签名并将所有工件上传到Maven Central
   802  	os.Rename(archive, meta.Package+".aar")
   803  	if *signer != "" && *deploy != "" {
   804  //将签名密钥导入本地GPG实例
   805  		b64key := os.Getenv(*signer)
   806  		key, err := base64.StdEncoding.DecodeString(b64key)
   807  		if err != nil {
   808  			log.Fatalf("invalid base64 %s", *signer)
   809  		}
   810  		gpg := exec.Command("gpg", "--import")
   811  		gpg.Stdin = bytes.NewReader(key)
   812  		build.MustRun(gpg)
   813  
   814  		keyID, err := build.PGPKeyID(string(key))
   815  		if err != nil {
   816  			log.Fatal(err)
   817  		}
   818  //将工件上传到Sonatype和/或Maven Central
   819  		repo := *deploy + "/service/local/staging/deploy/maven2"
   820  		if meta.Develop {
   821  			repo = *deploy + "/content/repositories/snapshots"
   822  		}
   823  		build.MustRunCommand("mvn", "gpg:sign-and-deploy-file", "-e", "-X",
   824  			"-settings=build/mvn.settings", "-Durl="+repo, "-DrepositoryId=ossrh",
   825  			"-Dgpg.keyname="+keyID,
   826  			"-DpomFile="+meta.Package+".pom", "-Dfile="+meta.Package+".aar")
   827  	}
   828  }
   829  
   830  func gomobileTool(subcmd string, args ...string) *exec.Cmd {
   831  	cmd := exec.Command(filepath.Join(GOBIN, "gomobile"), subcmd)
   832  	cmd.Args = append(cmd.Args, args...)
   833  	cmd.Env = []string{
   834  		"GOPATH=" + build.GOPATH(),
   835  		"PATH=" + GOBIN + string(os.PathListSeparator) + os.Getenv("PATH"),
   836  	}
   837  	for _, e := range os.Environ() {
   838  		if strings.HasPrefix(e, "GOPATH=") || strings.HasPrefix(e, "PATH=") {
   839  			continue
   840  		}
   841  		cmd.Env = append(cmd.Env, e)
   842  	}
   843  	return cmd
   844  }
   845  
   846  type mavenMetadata struct {
   847  	Version      string
   848  	Package      string
   849  	Develop      bool
   850  	Contributors []mavenContributor
   851  }
   852  
   853  type mavenContributor struct {
   854  	Name  string
   855  	Email string
   856  }
   857  
   858  func newMavenMetadata(env build.Environment) mavenMetadata {
   859  //从repo根目录收集作者列表
   860  	contribs := []mavenContributor{}
   861  	if authors, err := os.Open("AUTHORS"); err == nil {
   862  		defer authors.Close()
   863  
   864  		scanner := bufio.NewScanner(authors)
   865  		for scanner.Scan() {
   866  //跳过作者列表中的任何空白
   867  			line := strings.TrimSpace(scanner.Text())
   868  			if line == "" || line[0] == '#' {
   869  				continue
   870  			}
   871  //拆分作者并插入为参与者
   872  			re := regexp.MustCompile("([^<]+) <(.+)>")
   873  			parts := re.FindStringSubmatch(line)
   874  			if len(parts) == 3 {
   875  				contribs = append(contribs, mavenContributor{Name: parts[1], Email: parts[2]})
   876  			}
   877  		}
   878  	}
   879  //呈现版本和包字符串
   880  	version := params.Version
   881  	if isUnstableBuild(env) {
   882  		version += "-SNAPSHOT"
   883  	}
   884  	return mavenMetadata{
   885  		Version:      version,
   886  		Package:      "geth-" + version,
   887  		Develop:      isUnstableBuild(env),
   888  		Contributors: contribs,
   889  	}
   890  }
   891  
   892  //Xcode框架
   893  
   894  func doXCodeFramework(cmdline []string) {
   895  	var (
   896  		local  = flag.Bool("local", false, `Flag whether we're only doing a local build (skip Maven artifacts)`)
   897  		signer = flag.String("signer", "", `Environment variable holding the signing key (e.g. IOS_SIGNING_KEY)`)
   898  		deploy = flag.String("deploy", "", `Destination to deploy the archive (usually "trunk")`)
   899  		upload = flag.String("upload", "", `Destination to upload the archives (usually "gethstore/builds")`)
   900  	)
   901  	flag.CommandLine.Parse(cmdline)
   902  	env := build.Env()
   903  
   904  //构建iOS Xcode框架
   905  	build.MustRun(goTool("get", "golang.org/x/mobile/cmd/gomobile", "golang.org/x/mobile/cmd/gobind"))
   906  	build.MustRun(gomobileTool("init"))
   907  	bind := gomobileTool("bind", "-ldflags", "-s -w", "--target", "ios", "--tags", "ios", "-v", "github.com/ethereum/go-ethereum/mobile")
   908  
   909  	if *local {
   910  //如果我们在本地生成,请使用build文件夹,然后停止
   911  		bind.Dir, _ = filepath.Abs(GOBIN)
   912  		build.MustRun(bind)
   913  		return
   914  	}
   915  	archive := "geth-" + archiveBasename("ios", params.ArchiveVersion(env.Commit))
   916  	if err := os.Mkdir(archive, os.ModePerm); err != nil {
   917  		log.Fatal(err)
   918  	}
   919  	bind.Dir, _ = filepath.Abs(archive)
   920  	build.MustRun(bind)
   921  	build.MustRunCommand("tar", "-zcvf", archive+".tar.gz", archive)
   922  
   923  //跳过cocoapods deploy和azure upload for pr builds
   924  	maybeSkipArchive(env)
   925  
   926  //签名并将框架上载到Azure
   927  	if err := archiveUpload(archive+".tar.gz", *upload, *signer); err != nil {
   928  		log.Fatal(err)
   929  	}
   930  //准备并上传一个podspec到cocoapods
   931  	if *deploy != "" {
   932  		meta := newPodMetadata(env, archive)
   933  		build.Render("build/pod.podspec", "Geth.podspec", 0755, meta)
   934  		build.MustRunCommand("pod", *deploy, "push", "Geth.podspec", "--allow-warnings", "--verbose")
   935  	}
   936  }
   937  
   938  type podMetadata struct {
   939  	Version      string
   940  	Commit       string
   941  	Archive      string
   942  	Contributors []podContributor
   943  }
   944  
   945  type podContributor struct {
   946  	Name  string
   947  	Email string
   948  }
   949  
   950  func newPodMetadata(env build.Environment, archive string) podMetadata {
   951  //从repo根目录收集作者列表
   952  	contribs := []podContributor{}
   953  	if authors, err := os.Open("AUTHORS"); err == nil {
   954  		defer authors.Close()
   955  
   956  		scanner := bufio.NewScanner(authors)
   957  		for scanner.Scan() {
   958  //跳过作者列表中的任何空白
   959  			line := strings.TrimSpace(scanner.Text())
   960  			if line == "" || line[0] == '#' {
   961  				continue
   962  			}
   963  //拆分作者并插入为参与者
   964  			re := regexp.MustCompile("([^<]+) <(.+)>")
   965  			parts := re.FindStringSubmatch(line)
   966  			if len(parts) == 3 {
   967  				contribs = append(contribs, podContributor{Name: parts[1], Email: parts[2]})
   968  			}
   969  		}
   970  	}
   971  	version := params.Version
   972  	if isUnstableBuild(env) {
   973  		version += "-unstable." + env.Buildnum
   974  	}
   975  	return podMetadata{
   976  		Archive:      archive,
   977  		Version:      version,
   978  		Commit:       env.Commit,
   979  		Contributors: contribs,
   980  	}
   981  }
   982  
   983  //交叉汇编
   984  
   985  func doXgo(cmdline []string) {
   986  	var (
   987  		alltools = flag.Bool("alltools", false, `Flag whether we're building all known tools, or only on in particular`)
   988  	)
   989  	flag.CommandLine.Parse(cmdline)
   990  	env := build.Env()
   991  
   992  //确保xgo可用于交叉编译
   993  	gogetxgo := goTool("get", "github.com/karalabe/xgo")
   994  	build.MustRun(gogetxgo)
   995  
   996  //如果请求所有工具生成,则生成生成器需要的所有内容
   997  	args := append(buildFlags(env), flag.Args()...)
   998  
   999  	if *alltools {
  1000  		args = append(args, []string{"--dest", GOBIN}...)
  1001  		for _, res := range allCrossCompiledArchiveFiles {
  1002  			if strings.HasPrefix(res, GOBIN) {
  1003  //找到二进制工具,显式地交叉构建它
  1004  				args = append(args, "./"+filepath.Join("cmd", filepath.Base(res)))
  1005  				xgo := xgoTool(args)
  1006  				build.MustRun(xgo)
  1007  				args = args[:len(args)-1]
  1008  			}
  1009  		}
  1010  		return
  1011  	}
  1012  //否则,执行显式交叉编译
  1013  	path := args[len(args)-1]
  1014  	args = append(args[:len(args)-1], []string{"--dest", GOBIN, path}...)
  1015  
  1016  	xgo := xgoTool(args)
  1017  	build.MustRun(xgo)
  1018  }
  1019  
  1020  func xgoTool(args []string) *exec.Cmd {
  1021  	cmd := exec.Command(filepath.Join(GOBIN, "xgo"), args...)
  1022  	cmd.Env = []string{
  1023  		"GOPATH=" + build.GOPATH(),
  1024  		"GOBIN=" + GOBIN,
  1025  	}
  1026  	for _, e := range os.Environ() {
  1027  		if strings.HasPrefix(e, "GOPATH=") || strings.HasPrefix(e, "GOBIN=") {
  1028  			continue
  1029  		}
  1030  		cmd.Env = append(cmd.Env, e)
  1031  	}
  1032  	return cmd
  1033  }
  1034  
  1035  //二元分布清理
  1036  
  1037  func doPurge(cmdline []string) {
  1038  	var (
  1039  		store = flag.String("store", "", `Destination from where to purge archives (usually "gethstore/builds")`)
  1040  		limit = flag.Int("days", 30, `Age threshold above which to delete unstalbe archives`)
  1041  	)
  1042  	flag.CommandLine.Parse(cmdline)
  1043  
  1044  	if env := build.Env(); !env.IsCronJob {
  1045  		log.Printf("skipping because not a cron job")
  1046  		os.Exit(0)
  1047  	}
  1048  //创建Azure身份验证并列出当前存档
  1049  	auth := build.AzureBlobstoreConfig{
  1050  		Account:   strings.Split(*store, "/")[0],
  1051  		Token:     os.Getenv("AZURE_BLOBSTORE_TOKEN"),
  1052  		Container: strings.SplitN(*store, "/", 2)[1],
  1053  	}
  1054  	blobs, err := build.AzureBlobstoreList(auth)
  1055  	if err != nil {
  1056  		log.Fatal(err)
  1057  	}
  1058  //迭代blob,收集并排序所有不稳定的构建
  1059  	for i := 0; i < len(blobs); i++ {
  1060  		if !strings.Contains(blobs[i].Name, "unstable") {
  1061  			blobs = append(blobs[:i], blobs[i+1:]...)
  1062  			i--
  1063  		}
  1064  	}
  1065  	for i := 0; i < len(blobs); i++ {
  1066  		for j := i + 1; j < len(blobs); j++ {
  1067  			if blobs[i].Properties.LastModified.After(blobs[j].Properties.LastModified) {
  1068  				blobs[i], blobs[j] = blobs[j], blobs[i]
  1069  			}
  1070  		}
  1071  	}
  1072  //筛选出比给定阈值更新的所有存档
  1073  	for i, blob := range blobs {
  1074  		if time.Since(blob.Properties.LastModified) < time.Duration(*limit)*24*time.Hour {
  1075  			blobs = blobs[:i]
  1076  			break
  1077  		}
  1078  	}
  1079  //删除所有标记为此类的内容并返回
  1080  	if err := build.AzureBlobstoreDelete(auth, blobs); err != nil {
  1081  		log.Fatal(err)
  1082  	}
  1083  }
  1084