github.com/buildtool/build-tools@v0.2.29-0.20240322150259-6a1d0a553c23/pkg/ci/github.go (about)

     1  // MIT License
     2  //
     3  // Copyright (c) 2018 buildtool
     4  //
     5  // Permission is hereby granted, free of charge, to any person obtaining a copy
     6  // of this software and associated documentation files (the "Software"), to deal
     7  // in the Software without restriction, including without limitation the rights
     8  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     9  // copies of the Software, and to permit persons to whom the Software is
    10  // furnished to do so, subject to the following conditions:
    11  //
    12  // The above copyright notice and this permission notice shall be included in all
    13  // copies or substantial portions of the Software.
    14  //
    15  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    16  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    17  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    18  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    19  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    20  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    21  // SOFTWARE.
    22  
    23  package ci
    24  
    25  import (
    26  	"strings"
    27  )
    28  
    29  type Github struct {
    30  	*Common
    31  	CICommit     string `env:"GITHUB_SHA"`
    32  	CIBuildName  string `env:"RUNNER_WORKSPACE"`
    33  	CIBranchName string `env:"GITHUB_REF"`
    34  }
    35  
    36  var _ CI = &Github{}
    37  
    38  func (c *Github) Name() string {
    39  	return "Github"
    40  }
    41  
    42  func (c *Github) BranchReplaceSlash() string {
    43  	return branchReplaceSlash(c.Branch())
    44  }
    45  
    46  func (c *Github) BuildName() string {
    47  	return c.Common.BuildName(strings.TrimPrefix(c.CIBuildName, "/home/runner/work/"))
    48  }
    49  
    50  func (c *Github) Branch() string {
    51  	if strings.HasPrefix(c.CIBranchName, "refs/heads") {
    52  		return c.Common.Branch(strings.TrimPrefix(c.CIBranchName, "refs/heads/"))
    53  	} else if strings.HasPrefix(c.CIBranchName, "refs/tags") {
    54  		return c.Common.Branch(strings.TrimPrefix(c.CIBranchName, "refs/tags/"))
    55  	} else {
    56  		return c.Common.Branch(c.CIBranchName)
    57  	}
    58  }
    59  
    60  func (c *Github) Commit() string {
    61  	return c.Common.Commit(c.CICommit)
    62  }
    63  
    64  func (c *Github) Configured() bool {
    65  	return c.CIBuildName != ""
    66  }