github.com/buildtool/build-tools@v0.2.29-0.20240322150259-6a1d0a553c23/pkg/vcs/vcs.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 vcs 24 25 // VCS represent the VersionControlSystem used 26 type VCS interface { 27 // Identify returns true if it is the expected VCS type (based on information found in dir) 28 Identify(dir string) bool 29 // Name returns the name of the VCS 30 Name() string 31 // Branch returns the current branch 32 Branch() string 33 // Commit returns the current commit 34 Commit() string 35 } 36 37 // CommonVCS contains functions shared by all VCSs 38 type CommonVCS struct { 39 CurrentBranch string 40 CurrentCommit string 41 } 42 43 // Branch returns the current branch 44 func (v CommonVCS) Branch() string { 45 return v.CurrentBranch 46 } 47 48 // Commit returns the current commit 49 func (v CommonVCS) Commit() string { 50 return v.CurrentCommit 51 } 52 53 var systems = []VCS{&git{}} 54 55 // Identify tries to identify the actual VCS 56 func Identify(dir string) VCS { 57 for _, vcs := range systems { 58 if vcs.Identify(dir) { 59 return vcs 60 } 61 } 62 63 no := &no{CommonVCS: CommonVCS{}} 64 return no 65 }