1
1
# Release Notes Presence Checker
2
2
3
+ - [ Motivation] ( #motivation )
4
+ - [ Requirements] ( #requirements )
5
+ - [ Inputs] ( #inputs )
6
+ - [ Outputs] ( #outputs )
7
+ - [ Usage] ( #usage )
8
+ - [ Running Static Code Analysis] ( #running-static-code-analysis )
9
+ - [ Run Black Tool Locally] ( #run-black-tool-locally )
10
+ - [ Running Unit Test] ( #running-unit-test )
11
+ - [ Code Coverage] ( #code-coverage )
12
+ - [ Run Action Locally] ( #run-action-locally )
13
+ - [ Contribution Guidelines] ( #contribution-guidelines )
14
+ - [ License Information] ( #license-information )
15
+ - [ Contact or Support Information] ( #contact-or-support-information )
16
+
3
17
A GH action for validating the presence of release notes in pull requests.
4
18
5
19
## Motivation
@@ -29,7 +43,8 @@ This action is designed to help maintainers and contributors ensure that release
29
43
- ** Required** : Yes
30
44
31
45
### ` location `
32
- - ** Description** : The location of the release notes in the pull request. Example: ` body ` .
46
+ - ** Description** : The location of the release notes in the pull request.
47
+ - ** Default** : ` body `
33
48
- ** Required** : No
34
49
35
50
### ` title `
@@ -58,6 +73,10 @@ This action is designed to help maintainers and contributors ensure that release
58
73
See the default action step definition:
59
74
60
75
``` yaml
76
+
77
+ with :
78
+ python-version : ' 3.11'
79
+
61
80
- name : Release Notes Presence Check
62
81
id : release_notes_presence_check
63
82
@@ -70,7 +89,7 @@ See the default action step definition:
70
89
title : " [Rr]elease [Nn]otes:"
71
90
skip-labels : " skip-release-notes,no-release-notes"
72
91
fails-on-error : " false"
73
- ` ` `
92
+ ` ` `
74
93
75
94
## Running Static Code Analysis
76
95
0 commit comments