diff --git a/src/engine/tcr.go b/src/engine/tcr.go index 071d5b4b..53c2c7a0 100644 --- a/src/engine/tcr.go +++ b/src/engine/tcr.go @@ -229,7 +229,7 @@ func (tcr *TCREngine) PrintStats(p params.Params) { } // GenerateRetro generates a retrospective markdown file template using stats -func (tcr *TCREngine) GenerateRetro(_p params.Params) { +func (tcr *TCREngine) GenerateRetro(_ params.Params) { //TODO implement me panic("implement me") } diff --git a/src/retro/retrospective.go b/src/retro/retrospective.go index b523d3ad..1c8bd2ea 100644 --- a/src/retro/retrospective.go +++ b/src/retro/retrospective.go @@ -24,21 +24,24 @@ package retro import ( "bytes" + _ "embed" "github.com/murex/tcr/events" "text/template" ) +//go:embed template/retro.md +var tmpl string + +// GenerateMarkdown builds retrospective markdown contents func GenerateMarkdown(tcrEvents *events.TcrEvents) string { t := template.New("QuickRetro") - t, _ = t.Parse("# Quick Retrospective\n" + - "Average passed commit size: {{.GreenAvg}}\n" + - "Average failed commit size: {{.RedAvg}}\n") + t, _ = t.Parse(tmpl) greenAvg := tcrEvents.AllLineChangesPerGreenCommit().Avg() redAvg := tcrEvents.AllLineChangesPerRedCommit().Avg() buf := new(bytes.Buffer) - t.Execute(buf, struct { + _ = t.Execute(buf, struct { GreenAvg any RedAvg any }{greenAvg, redAvg}) diff --git a/src/retro/template/retro.md b/src/retro/template/retro.md new file mode 100644 index 00000000..d79fd389 --- /dev/null +++ b/src/retro/template/retro.md @@ -0,0 +1,40 @@ +# Quick Retrospective + +## TODO - Session Name + +| Team | Date | +|------|------------| +| XXX | MM/DD/YYYY | + +## Session's TCR metrics + +- Average passed commit size: {{.GreenAvg}} +- Average failed commit size: {{.RedAvg}} + +## DO + +_`What did we do?`_ + +- +- + +## LEARN + +_`What did we learn?`_ + +- +- + +## PUZZLE + +_`What still puzzles us?`_ + +- +- + +## DECIDE + +_`How can we apply this in the future?`_ + +- +-