Class: Apadmi::Grout::DefaultTemplates

Inherits:
Object
  • Object
show all
Defined in:
lib/apadmi/grout/models/release_notes_templates.rb

Overview

Default baked in templates for generating release notes

Instance Method Summary collapse

Instance Method Details

#default_document_template ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/apadmi/grout/models/release_notes_templates.rb', line 7

def default_document_template
  %{# {{config.title}}

### Version
{{config.app_version}}

{{#config.has_environment?}}
### Environment
{{config.environment}}

{{/config.has_environment?}}
### Build date
{{config.date}}

{{#config.has_min_os_version?}}
### Minimum Supported OS
{{config.min_os_version}}

{{/config.has_min_os_version?}}
### Build Details
Commit Hash: {{config.commit_hash}}
[CI/CD build \#{{config.ci_build_number}}]({{config.ci_build_url}})

{{#config.has_moved_issues?}}
## Tickets Moved By This Build
{{ rendered_moved_issues }}
{{/config.has_moved_issues?}}
{{#config.has_release_issues?}}
## Sprint Release notes
{{ rendered_release_issues }}
{{/config.has_release_issues?}}}
end

#default_list_template ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/apadmi/grout/models/release_notes_templates.rb', line 40

def default_list_template
  %{### New functionality
{{# classified_issues.features.first}}
{{# classified_issues.features}}
* [{{ key }} - {{ summary }}]({{ url }})
{{/ classified_issues.features}}

{{/ classified_issues.features.first}}
{{# classified_issues.improvements.first}}
### Improvements
  {{# classified_issues.improvements}}
* [{{ key }} - {{ summary }}]({{ url }})
  {{/ classified_issues.improvements}}

{{/ classified_issues.improvements.first}}
{{# classified_issues.tasks.first}}
### Completed Tasks
  {{# classified_issues.tasks}}
* [{{ key }} - {{ summary }}]({{ url }})
  {{/ classified_issues.tasks}}

{{/ classified_issues.tasks.first}}
{{# classified_issues.defects.first}}
### Fixed defects
  {{# classified_issues.defects}}
* [{{ key }} - {{ summary }}]({{ url }})
  {{/ classified_issues.defects}}

{{/ classified_issues.defects.first}}
{{# classified_issues.others.first}}
### Other issue types
  {{# classified_issues.others}}
* [{{issue_type}} - {{ key }} - {{ summary }}]({{ url }})
  {{/ classified_issues.others}}

{{/ classified_issues.others.first}}{{# classified_issues.unclassified.first}}
### Unclassified
  {{# classified_issues.unclassified}}
* {{ key }} - {{ summary }}
  {{/ classified_issues.unclassified}}

_Note: These commits reference ticket IDs that could not be found in the board._

{{/ classified_issues.unclassified.first}}}
end