mirror of
https://github.com/go-task/task.git
synced 2025-03-29 21:57:04 +02:00
Fixes #647 This allows CI systems that support grouping (such as with [GitHub Actions's `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) and [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#formatting-commands)) to collapse all of the logs for a single task, to improve readability of logs ## Example The following Taskfile ``` # Taskfile.yml version: 3 output: group: begin: "::group::{{ .TASK }}" end: "::endgroup::" tasks: default: cmds: - "echo 'Hello, World!'" ``` Results in the following output ```bash $ task task: [default] echo 'Hello, World!' ::group::default Hello, World! ::endgroup:: ``` See [this GitHub Actions job](https://github.com/janslow/task/runs/4811059609?check_suite_focus=true) for a full example <img width="771" alt="image" src="https://user-images.githubusercontent.com/1253367/149429832-6cb0c1b5-0758-442e-9375-c4daa65771bc.png"> <img width="394" alt="image" src="https://user-images.githubusercontent.com/1253367/149429851-1d5d2ab5-9095-4795-9b57-f91750720d40.png">
45 lines
809 B
Go
45 lines
809 B
Go
package output
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
)
|
|
|
|
type Group struct{
|
|
Begin, End string
|
|
}
|
|
|
|
func (g Group) WrapWriter(w io.Writer, _ string, tmpl Templater) io.Writer {
|
|
gw := &groupWriter{writer: w}
|
|
if g.Begin != "" {
|
|
gw.begin = tmpl.Replace(g.Begin) + "\n"
|
|
}
|
|
if g.End != "" {
|
|
gw.end = tmpl.Replace(g.End) + "\n"
|
|
}
|
|
return gw
|
|
}
|
|
|
|
type groupWriter struct {
|
|
writer io.Writer
|
|
buff bytes.Buffer
|
|
begin, end string
|
|
}
|
|
|
|
func (gw *groupWriter) Write(p []byte) (int, error) {
|
|
return gw.buff.Write(p)
|
|
}
|
|
|
|
func (gw *groupWriter) Close() error {
|
|
if gw.buff.Len() == 0 {
|
|
// don't print begin/end messages if there's no buffered entries
|
|
return nil
|
|
}
|
|
if _, err := io.WriteString(gw.writer, gw.begin); err != nil {
|
|
return err
|
|
}
|
|
gw.buff.WriteString(gw.end)
|
|
_, err := io.Copy(gw.writer, &gw.buff)
|
|
return err
|
|
}
|