go/task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2025-08-10 22:42:19 +02:00
Code Issues Releases Activity

Improvements and CHANGELOG for #651

Browse Source
This commit is contained in:
Andrey Nering
2022-02-19 19:31:27 -03:00
parent cfb665310e
commit b323531dd5
8 changed files with 103 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@@ -2,8 +2,12 @@
## Unreleased
- Task now supports printing begin and end messages when using the `group`
output mode, useful for grouping tasks in CI systems.
[Check out the documentation](http://taskfile.dev/#/usage?id=output-syntax) for more information
([#647](https://github.com/go-task/task/issues/647), [#651](https://github.com/go-task/task/pull/651)).
- Add `Taskfile.dist.yml` and `Taskfile.dist.yaml` to the supported file
name list. [Check out the documentation for more information](https://taskfile.dev/#/usage?id=supported-file-names).
name list. [Check out the documentation](https://taskfile.dev/#/usage?id=supported-file-names) for more information
([#498](https://github.com/go-task/task/issues/498), [#666](https://github.com/go-task/task/pull/666)).
## v3.10.0 - 2022-01-04

3
cmd/task/task.go
View File

@@ -11,7 +11,6 @@ import (
"strings"
"syscall"
outputpkg "github.com/go-task/task/v3/internal/output"
"github.com/spf13/pflag"
"mvdan.cc/sh/v3/syntax"
@@ -73,7 +72,7 @@ func main() {
concurrency int
dir string
entrypoint string
output outputpkg.Style
output taskfile.Output
color bool
)

7
docs/usage.md
View File

@@ -974,9 +974,10 @@ tasks:
to run.
When using the `group` output, you can optionally provide a templated message
to print at the start of the group. This can be useful for instructing CI
systems to group all of the output for a given task, such as with [GitHub
Actions' `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines).
to print at the start and end of the group. This can be useful for instructing
CI systems to group all of the output for a given task, such as with
[GitHub Actions' `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines)
or [Azure Pipelines](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?expand=1&view=azure-devops&tabs=bash#formatting-commands).
```yaml
version: '3'

34
internal/output/output.go
View File

@@ -1,9 +1,11 @@
package output
import (
"fmt"
"io"
)
"github.com/go-task/task/v3/taskfile"
)
// Templater executes a template engine.
// It is provided by the templater.Templater package.
@@ -15,3 +17,33 @@ type Templater interface {
type Output interface {
WrapWriter(w io.Writer, prefix string, tmpl Templater) io.Writer
}
// Build the Output for the requested taskfile.Output.
func BuildFor(o *taskfile.Output) (Output, error) {
switch o.Name {
case "interleaved", "":
if err := checkOutputGroupUnset(o); err != nil {
return nil, err
}
return Interleaved{}, nil
case "group":
return Group{
Begin: o.Group.Begin,
End: o.Group.End,
}, nil
case "prefixed":
if err := checkOutputGroupUnset(o); err != nil {
return nil, err
}
return Prefixed{}, nil
default:
return nil, fmt.Errorf(`task: output style %q not recognized`, o.Name)
}
}
func checkOutputGroupUnset(o *taskfile.Output) error {
if o.Group.IsSet() {
return fmt.Errorf("task: output style %q does not support the group begin/end parameter", o.Name)
}
return nil
}

85
internal/output/style.go
View File

@@ -1,85 +0,0 @@
package output
import (
"fmt"
)
// Style of the Task output
type Style struct {
// Name of the Style.
Name string `yaml:"-"`
// Group specific style
Group GroupStyle
}
// Build the Output for the requested Style.
func (s *Style) Build() (Output, error) {
switch s.Name {
case "interleaved", "":
return Interleaved{}, s.ensureGroupStyleUnset()
case "group":
return Group{
Begin: s.Group.Begin,
End: s.Group.End,
}, nil
case "prefixed":
return Prefixed{}, s.ensureGroupStyleUnset()
default:
return nil, fmt.Errorf(`task: output style %q not recognized`, s.Name)
}
}
func (s *Style) ensureGroupStyleUnset() error {
if s.Group.IsSet() {
return fmt.Errorf("task: output style %q does not support the group begin/end parameter", s.Name)
}
return nil
}
// IsSet returns true if and only if a custom output style is set.
func (s *Style) IsSet() bool {
return s.Name != ""
}
// UnmarshalYAML implements yaml.Unmarshaler
// It accepts a scalar node representing the Style.Name or a mapping node representing the GroupStyle.
func (s *Style) UnmarshalYAML(unmarshal func(interface{}) error) error {
var name string
if err := unmarshal(&name); err == nil {
return s.UnmarshalText([]byte(name))
}
var tmp struct {
Group *GroupStyle
}
if err := unmarshal(&tmp); err != nil {
return fmt.Errorf("task: output style must be a string or mapping with a \"group\" key: %w", err)
}
if tmp.Group == nil {
return fmt.Errorf("task: output style must have the \"group\" key when in mapping form")
}
*s = Style{
Name: "group",
Group: *tmp.Group,
}
return nil
}
// UnmarshalText implements encoding.TextUnmarshaler
// It accepts the Style.Node
func (s *Style) UnmarshalText(text []byte) error {
tmp := Style{Name: string(text)}
if _, err := tmp.Build(); err != nil {
return err
}
return nil
}
// GroupStyle is the style options specific to the Group style.
type GroupStyle struct{
Begin, End string
}
// IsSet returns true if and only if a custom output style is set.
func (g *GroupStyle) IsSet() bool {
return g != nil && *g != GroupStyle{}
}

7
task.go
View File

@@ -52,7 +52,7 @@ type Executor struct {
Logger *logger.Logger
Compiler compiler.Compiler
Output output.Output
OutputStyle output.Style
OutputStyle taskfile.Output
taskvars *taskfile.Vars
@@ -211,10 +211,9 @@ func (e *Executor) Setup() error {
if !e.OutputStyle.IsSet() {
e.OutputStyle = e.Taskfile.Output
}
if o, err := e.OutputStyle.Build(); err != nil {
e.Output, err = output.BuildFor(&e.OutputStyle)
if err != nil {
return err
} else {
e.Output = o
}
if e.Taskfile.Method == "" {

55
taskfile/output.go Normal file
View File

@@ -0,0 +1,55 @@
package taskfile
import (
"fmt"
)
// Output of the Task output
type Output struct {
// Name of the Output.
Name string `yaml:"-"`
// Group specific style
Group OutputGroup
}
// IsSet returns true if and only if a custom output style is set.
func (s *Output) IsSet() bool {
return s.Name != ""
}
// UnmarshalYAML implements yaml.Unmarshaler
// It accepts a scalar node representing the Output.Name or a mapping node representing the OutputGroup.
func (s *Output) UnmarshalYAML(unmarshal func(interface{}) error) error {
var name string
if err := unmarshal(&name); err == nil {
s.Name = name
return nil
}
var tmp struct {
Group *OutputGroup
}
if err := unmarshal(&tmp); err != nil {
return fmt.Errorf("task: output style must be a string or mapping with a \"group\" key: %w", err)
}
if tmp.Group == nil {
return fmt.Errorf("task: output style must have the \"group\" key when in mapping form")
}
*s = Output{
Name: "group",
Group: *tmp.Group,
}
return nil
}
// OutputGroup is the style options specific to the Group style.
type OutputGroup struct {
Begin, End string
}
// IsSet returns true if and only if a custom output style is set.
func (g *OutputGroup) IsSet() bool {
if g == nil {
return false
}
return g.Begin != "" || g.End != ""
}

6
taskfile/taskfile.go
View File

@@ -3,15 +3,13 @@ package taskfile
import (
"fmt"
"strconv"
"github.com/go-task/task/v3/internal/output"
)
// Taskfile represents a Taskfile.yml
type Taskfile struct {
Version string
Expansions int
Output output.Style
Output Output
Method string
Includes *IncludedTaskfiles
Vars *Vars
@@ -27,7 +25,7 @@ func (tf *Taskfile) UnmarshalYAML(unmarshal func(interface{}) error) error {
var taskfile struct {
Version string
Expansions int
Output output.Style
Output Output
Method string
Includes *IncludedTaskfiles
Vars *Vars