-
Notifications
You must be signed in to change notification settings - Fork 405
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add git common build template params
This includes a number of template parameters supported by [goreleaser](https://goreleaser.com/customization/templates/). Specifically, the build date information and the majority of the Git params. Fixes #493 Signed-off-by: Nathan Mittler <nmittler@aviatrix.com>
- Loading branch information
Showing
9 changed files
with
1,168 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // Copyright 2024 ko Build Authors All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // MIT License | ||
| // | ||
| // Copyright (c) 2016-2022 Carlos Alexandro Becker | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
|
|
||
| package git | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| ) | ||
|
|
||
| var ( | ||
| // ErrNoTag happens if the underlying git repository doesn't contain any tags | ||
| // but no snapshot-release was requested. | ||
| ErrNoTag = errors.New("git doesn't contain any tags. Tag info will not be available") | ||
|
|
||
| // ErrNotRepository happens if you try to run ko against a folder | ||
| // which is not a git repository. | ||
| ErrNotRepository = errors.New("current folder is not a git repository. Git info will not be available") | ||
|
|
||
| // ErrNoGit happens when git is not present in PATH. | ||
| ErrNoGit = errors.New("git not present in PATH. Git info will not be available") | ||
| ) | ||
|
|
||
| // ErrDirty happens when the repo has uncommitted/unstashed changes. | ||
| type ErrDirty struct { | ||
| status string | ||
| } | ||
|
|
||
| func (e ErrDirty) Error() string { | ||
| return fmt.Sprintf("git is in a dirty state\nPlease check in your pipeline what can be changing the following files:\n%v\n", e.status) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| // Copyright 2024 ko Build Authors All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // MIT License | ||
| // | ||
| // Copyright (c) 2016-2022 Carlos Alexandro Becker | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. | ||
|
|
||
| package git | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "errors" | ||
| "os/exec" | ||
| "strings" | ||
| ) | ||
|
|
||
| // isRepo returns true if current folder is a git repository. | ||
| func isRepo(ctx context.Context) bool { | ||
| out, err := run(ctx, "rev-parse", "--is-inside-work-tree") | ||
| return err == nil && strings.TrimSpace(out) == "true" | ||
| } | ||
|
|
||
| func runWithEnv(ctx context.Context, env []string, args ...string) (string, error) { | ||
| extraArgs := []string{ | ||
| "-c", "log.showSignature=false", | ||
| } | ||
| args = append(extraArgs, args...) | ||
| /* #nosec */ | ||
| cmd := exec.CommandContext(ctx, "git", args...) | ||
|
|
||
| stdout := bytes.Buffer{} | ||
| stderr := bytes.Buffer{} | ||
|
|
||
| cmd.Stdout = &stdout | ||
| cmd.Stderr = &stderr | ||
| cmd.Env = append(cmd.Env, env...) | ||
|
|
||
| err := cmd.Run() | ||
|
|
||
| if err != nil { | ||
| return "", errors.New(stderr.String()) | ||
| } | ||
|
|
||
| return stdout.String(), nil | ||
| } | ||
|
|
||
| // run runs a git command and returns its output or errors. | ||
| func run(ctx context.Context, args ...string) (string, error) { | ||
| return runWithEnv(ctx, []string{}, args...) | ||
| } | ||
|
|
||
| // clean the output. | ||
| func clean(output string, err error) (string, error) { | ||
| output = strings.ReplaceAll(strings.Split(output, "\n")[0], "'", "") | ||
| if err != nil { | ||
| err = errors.New(strings.TrimSuffix(err.Error(), "\n")) | ||
| } | ||
| return output, err | ||
| } | ||
|
|
||
| // cleanAllLines returns all the non-empty lines of the output, cleaned up. | ||
| func cleanAllLines(output string, err error) ([]string, error) { | ||
| var result []string | ||
| for _, line := range strings.Split(output, "\n") { | ||
| l := strings.TrimSpace(strings.ReplaceAll(line, "'", "")) | ||
| if l == "" { | ||
| continue | ||
| } | ||
| result = append(result, l) | ||
| } | ||
| // TODO: maybe check for exec.ExitError only? | ||
| if err != nil { | ||
| err = errors.New(strings.TrimSuffix(err.Error(), "\n")) | ||
| } | ||
| return result, err | ||
| } |
Oops, something went wrong.