github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/metadata/build_info.go (about)

     1  /*
     2   * Copyright (C) 2017 The "MysteriumNetwork/node" Authors.
     3   *
     4   * This program is free software: you can redistribute it and/or modify
     5   * it under the terms of the GNU General Public License as published by
     6   * the Free Software Foundation, either version 3 of the License, or
     7   * (at your option) any later version.
     8   *
     9   * This program is distributed in the hope that it will be useful,
    10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12   * GNU General Public License for more details.
    13   *
    14   * You should have received a copy of the GNU General Public License
    15   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    16   */
    17  
    18  // Package metadata contains build information of executable usually provided by
    19  // automated build systems like Travis. Default values are populated if not overridden by build system
    20  package metadata
    21  
    22  import "fmt"
    23  
    24  var (
    25  	// BuildCommit comes from BUILD_COMMIT env variable (set via linker flags)
    26  	BuildCommit = ""
    27  	// BuildBranch comes from BUILD_BRANCH env variable (set via linker flags)
    28  	BuildBranch = "<unknown>"
    29  	// BuildNumber comes from BUILD_NUMBER env variable (set via linker flags)
    30  	BuildNumber = "dev-build"
    31  )
    32  
    33  // BuildAsString returns all defined build constants as single string
    34  func BuildAsString() string {
    35  	return FormatString(BuildCommit, BuildBranch, BuildNumber)
    36  }
    37  
    38  // FormatString formats build info to string with given build data
    39  func FormatString(commit, branch, buildNumber string) string {
    40  	return fmt.Sprintf("Branch: %s. Build id: %s. Commit: %s", branch, buildNumber, commit)
    41  }