Skip to content

Commit 74dfa3a

Browse files
committed
Deprecate preamble & epilogue options
You can provide a Handlebars template for the comment body now.
1 parent 6db65a0 commit 74dfa3a

2 files changed

Lines changed: 21 additions & 4 deletions

File tree

src/configuration.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,18 @@ export interface CommentConfiguration {
2121
*/
2222
template?: string
2323

24-
/** Comment content to print above matching rules table */
24+
/**
25+
* Comment content to print above matching rules table
26+
*
27+
* @deprecated Use the template property
28+
*/
2529
preamble?: string
26-
/** Comment content to print below matching rules table */
30+
31+
/**
32+
* Comment content to print below matching rules table
33+
*
34+
* @deprecated Use the template property
35+
*/
2736
epilogue?: string
2837
}
2938

src/template-types.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,17 @@ export interface TemplateContext {
2929
/** GitHub users/teams that should be mentioned including metadata */
3030
mentions: Mention[]
3131

32-
/** content to print above matching rules table */
32+
/**
33+
* content to print above matching rules table
34+
*
35+
* @deprecated
36+
*/
3337
preamble: string | undefined
3438

35-
/** content to print below matching rules table */
39+
/**
40+
* content to print below matching rules table
41+
*
42+
* @deprecated
43+
*/
3644
epilogue: string | undefined
3745
}

0 commit comments

Comments
 (0)