143 |
144 | The names of the labels and the length of certain time periods can
145 | be configured in your repo config:
146 |
147 | ```javascript
148 | "my-repo": {
149 | // ...
150 | "cleanup": {
151 | "issue": {
152 | // [REQUIRED] Label manually applied for issues that need more information.
153 | "label_needs_info": "Needs Info",
154 |
155 | // [OPTIONAL] Label to be applied for issues that need Googler attention.
156 | // If unspecified, this state will not have a visible label.
157 | "label_needs_attention": "Needs Attention",
158 |
159 | // [REQUIRED] Label to be applied for issues that don't have recent activity
160 | "label_stale": "Stale",
161 |
162 | // [OPTIONAL] Label(s) that can be applied to issues to exempt them from the stale
163 | // checker.
164 | "ignore_labels": ["Feature Request", "Internal"],
165 |
166 | // [REQUIRED] Time, in days, to stay in the needs_info state before becoming stale
167 | // stale. These issues transition from label_needs_info to label_stale.
168 | "needs_info_days": 7,
169 |
170 | // [REQUIRED] Time, in days, to close an issue after the warning message is posted
171 | // if there is no recent activity. These issues will transition from
172 | // label_stale to closed.
173 | "stale_days": 3,
174 |
175 | // [OPTIONAL] Time, in days, to lock an issue after it has been closed.
176 | "lock_days": 60
177 | }
178 | }
179 | }
180 | ```
181 |
182 | ### Old Issue Locking
183 |
184 | The bot can lock issues that have been closed for a while to prevent new discussion.
185 | To enable this, add the `lock_days` key to your "stale issue config" (see above).
186 |
187 | ### Repo Reports
188 |
189 | The bot can send you a weekly report of how healthy your repo is. To receive this
190 | report, just add a reporting config:
191 |
192 | ```javascript
193 | "my-repo": {
194 | // ...
195 | "reports": {
196 | "email": "foo-engineering@googlegroups.com"
197 | }
198 | }
199 | ```
200 |
201 | You will then receive a weekly email with:
202 |
203 | * Change in open issues, stars, and forks.
204 | * List of which issues were opened in the past week.
205 | * List of which issues were closed in the past week.
206 |
207 | ## Monitoring
208 |
209 | The bot keeps a log of visible actions it takes on GitHub, which you can view on
210 | a per-repo basis:
211 |
212 | https://ossbot.computer/audit.html?org=ORG_NAME&repo=REPO_NAME
213 |
214 | ## Deployment
215 |
216 | ### Deploy Functions, Configuration, and Cron Jobs
217 |
218 | After completing all configuration below, run `make deploy`.
219 |
220 | ### Customize Configuration
221 |
222 | Edit the `functions/config/config.json` file to have configuration in the following form:
223 |
224 | ```javascript
225 | {
226 | "84 | ${link} 85 |
86 | 87 |88 | ${header} 89 |
90 | 91 |(This email is automatically generated, do not reply)
98 | 99 | ${smartmail_markup} 100 | 101 | `; 102 | 103 | return this.sendEmail(recipient, subject, body); 104 | } 105 | 106 | /** 107 | * Invisible email markup to add action in Gmail. 108 | * 109 | * Note: Get registered with google. 110 | * https://developers.google.com/gmail/markup/registering-with-google 111 | */ 112 | getSmartmailMarkup(url: string, title: string): string { 113 | const email_markup = ` 114 || Link | 46 |Time | 47 |Event | 48 |Target | 49 |Details | 50 |Reason | 51 |||
|---|---|---|---|---|---|---|---|
| link | 56 |{{entry.timeString()}} | 57 |{{entry.data.event}} | 58 |59 | {{entry.data.target}} 62 | | 63 |
64 |
|
73 | {{entry.data.reason || "N/A"}} | 74 |
| 29 | Repo 30 | | 31 |32 | 38 | 43 | | 44 |
| 47 | Stat 48 | | 49 |50 | 56 | | 57 |
| 60 | Time 61 | | 62 |63 | 69 | 74 | | 75 |
86 |
87 |
70 | I am the oss bot.
71 |
72 | I am your friend.
73 |
74 | Visit my GitHub
75 |
76 |
79 | The suggested action metric (SAM) score is a single number meant to help maintainers of open-source repositories get an at-a-glance health check for their repo. 80 |
81 |82 | The formula for SAM score is simple: 83 |
84 |85 |
86 | // Simple ratio: what percentage of all issues ever are still open? 87 | let open_ratio = (open_issues / open_issues + closed_issues) 88 | 89 | // Scale: how many total issues have you ever had? 90 | let scale_factor = (open_issues + closed_issues) 91 | 92 | // SAM score is the ratio of open to closed issues multiplied by a logarithmic 93 | // scale factor. 94 | let score = open_ratio * Math.log(Math.E + scale_factor)95 | 96 |
97 | The goal is to get the lowest SAM score possible without "gaming" the system through bug bankruptcy or other developer-unfriendly processes. 98 |
99 |100 | The basic principles are: 101 | 102 |
110 | SAM Scores fall into the following buckets: 111 | 112 |