diff --git a/.github/workflows/config/weekly_status_report_openlibrary_leads_g.json b/.github/workflows/config/weekly_status_report_openlibrary_leads_g.json index 090ccabfafe..43ac6029a72 100644 --- a/.github/workflows/config/weekly_status_report_openlibrary_leads_g.json +++ b/.github/workflows/config/weekly_status_report_openlibrary_leads_g.json @@ -1,6 +1,6 @@ { "slackChannel": "#openlibrary-leads-g", - "forStaff": false, + "publishFullDigest": false, "leads": [ { "githubUsername": "hornc", diff --git a/.github/workflows/config/weekly_status_report_team_abc.json b/.github/workflows/config/weekly_status_report_team_abc.json index 83d502cdf27..a9e8ed4e422 100644 --- a/.github/workflows/config/weekly_status_report_team_abc.json +++ b/.github/workflows/config/weekly_status_report_team_abc.json @@ -1,6 +1,6 @@ { "slackChannel": "#team-abc-plus", - "forStaff": true, + "publishFullDigest": true, "leads": [ { "githubUsername": "mekarpeles", diff --git a/scripts/gh_scripts/README.md b/scripts/gh_scripts/README.md index 252c4f80a43..16aed5a2082 100644 --- a/scripts/gh_scripts/README.md +++ b/scripts/gh_scripts/README.md @@ -87,7 +87,7 @@ A configuration file is required for this script to run properly. The file shou `slackChannel` : The digest will be published here. -`forStaff` : Boolean that flags whether this digest is for staff, or for other leads. If `false`, the digest will be published without several sections. +`publishFullDigest` : Boolean that flags whether to publish a full or partial digest. If `false`, the digest will be published without several sections (see **Details**, below). `leads` : Array of configurations for each lead. @@ -103,12 +103,12 @@ The script prepares a digest containing the following sections: *Recent comments* : A list of links to issues that need comments, broken down by lead. -*Needs: Lead/Assignee* : Lists of pull requests that do not have an assignee, and issues that need a lead. Only present if `staffOnly` is `true`. +*Needs: Lead/Assignee* : Lists of pull requests that do not have an assignee, and issues that need a lead. Only present if `publishFullDigest` is `true`. -*Untriaged issues* : List of issues which have the https://github.com/internetarchive/openlibrary/labels/Needs%3A%20Triage label. Only present if `forStaff` is `true`. +*Untriaged issues* : List of issues which have the https://github.com/internetarchive/openlibrary/labels/Needs%3A%20Triage label. Only present if `publishFullDigest` is `true`. *Assigned PRs* : List of pull requests that have been assigned, broken down by lead. Links to higher priority PRs are also included here. -*Staff PRs* : List of all open staff PRs. Only present if `forStaff` is `true`. +*Staff PRs* : List of all open staff PRs. Only present if `publishFullDigest` is `true`. *Submitter Input for PRs* : List of PRs that are labeled https://github.com/internetarchive/openlibrary/labels/Needs%3A%20Submitter%20Input, broken down by leads. diff --git a/scripts/gh_scripts/weekly_status_report.mjs b/scripts/gh_scripts/weekly_status_report.mjs index 9fc7033a8b5..843e0ad43bc 100644 --- a/scripts/gh_scripts/weekly_status_report.mjs +++ b/scripts/gh_scripts/weekly_status_report.mjs @@ -27,14 +27,14 @@ async function main() { const openPullRequests = await fetchOpenPullRequests() const nonDraftPullRequests = openPullRequests.filter((pull) => !pull.draft) - if (config.forStaff) { + if (config.publishFullDigest) { await prepareUnassignedItems(nonDraftPullRequests) .then((results) => lines.push(...results)) await prepareUntriagedIssues(config.leads) .then((results) => lines.push(...results)) } lines.push(...prepareAssignedPullRequests(nonDraftPullRequests, config.leads)) - if (config.forStaff) { + if (config.publishFullDigest) { lines.push(...prepareStaffPullRequests(nonDraftPullRequests, config.leads)) } lines.push(...prepareSubmitterInput(nonDraftPullRequests, config.leads)) @@ -56,9 +56,9 @@ async function main() { * Represents a configuration for this script. * * @typedef {Object} Config - * @property {string} slackChannel The Slack channel where messages will be posted - * @property {boolean} forStaff `true` if this digest is for staff only - * @property {Array} leads Project leads that will be included in this digest + * @property {string} slackChannel The Slack channel where messages will be posted + * @property {boolean} publishFullDigest `true` if this digest is for staff only + * @property {Array} leads Project leads that will be included in this digest */ /**