rework to be more uniform

Author: Niko Matsakis

mdbook-goals/src/templates.rs

@@ -43,9 +43,9 @@ handlebars::handlebars_helper!(is_complete: |p: Progress| match p {
 #[derive(Serialize, Debug)]
 pub struct Updates {
     pub milestone: String,
-    pub flagship_goals: Vec<UpdatesFlagshipGoal>,
-    pub other_goals_with_updates: Vec<UpdatesOtherGoal>,
-    pub other_goals_without_updates: Vec<UpdatesOtherGoal>,
+    pub flagship_goals: Vec<UpdatesGoal>,
+    pub other_goals_with_updates: Vec<UpdatesGoal>,
+    pub other_goals_without_updates: Vec<UpdatesGoal>,
 }
 
 impl Updates {
@@ -57,48 +57,7 @@ impl Updates {
 
 /// Part of the parameters expected by the `updates.md` template.
 #[derive(Serialize, Debug)]
-pub struct UpdatesFlagshipGoal {
-    /// Title of the tracking issue
-    pub title: String,
-
-    /// Tracking issue number on the project goals repository
-    pub issue_number: u64,
-
-    /// Comma-separated list of assignees
-    pub issue_assignees: String,
-
-    /// URL of the tracking issue
-    pub issue_url: String,
-
-    /// True if the issue is closed.
-    pub is_closed: bool,
-
-    /// Progress towards the goal
-    pub progress: Progress,
-
-    /// Updates provided towards the goal
-    pub updates: Vec<UpdatesFlagshipGoalUpdate>,
-}
-
-/// Part of the parameters expected by the `updates.md` template.
-#[derive(Serialize, Debug)]
-pub struct UpdatesFlagshipGoalUpdate {
-    /// Username of the person who wrote the update
-    pub author: String,
-
-    /// Formatted like "Oct 26"
-    pub date: String,
-
-    /// Text of the update
-    pub update: String,
-
-    /// URL of the comment
-    pub url: String,
-}
-
-/// Part of the parameters expected by the `updates.md` template.
-#[derive(Serialize, Debug)]
-pub struct UpdatesOtherGoal {
+pub struct UpdatesGoal {
     /// Title of the tracking issue
     pub title: String,
 

mdbook-goals/src/updates.rs

@@ -6,15 +6,15 @@ use std::path::Path;
 use std::process::{Command, Stdio};
 
 use crate::gh::issues::ExistingGithubIssue;
-use crate::templates::Updates;
+use crate::templates::{Updates, UpdatesGoal};
 use crate::{
     gh::{
         issue_id::{IssueId, Repository},
         issues::{list_issue_titles_in_milestone, ExistingGithubComment, ExistingIssueState},
     },
     json::checkboxes,
     llm::LargeLanguageModel,
-    templates::{self, UpdatesFlagshipGoal, UpdatesFlagshipGoalUpdate, UpdatesOtherGoal},
+    templates,
     util::comma,
 };
 
@@ -114,8 +114,8 @@ async fn prepare_flagship_goals(
     repository: &Repository,
     issues: &BTreeMap<String, ExistingGithubIssue>,
     filter: &Filter<'_>,
-    _llm: &LargeLanguageModel,
-    _quick: bool,
+    llm: &LargeLanguageModel,
+    quick: bool,
     updates: &mut Updates,
 ) -> anyhow::Result<()> {
     // First process the flagship goals, for which we capture the full text of comments.
@@ -133,7 +133,36 @@ async fn prepare_flagship_goals(
 
         let progress = checkboxes(&issue);
 
-        updates.flagship_goals.push(UpdatesFlagshipGoal {
+        let mut comments = issue.comments.clone();
+        comments.sort_by_key(|c| c.created_at.clone());
+        comments.retain(|c| filter.matches(c));
+
+        let summary: String = if comments.len() == 0 {
+            format!("No updates in this period.")
+        } else if quick {
+            QUICK_UPDATES.iter().copied().collect()
+        } else {
+            let prompt = format!(
+                "The following comments are updates to a project goal entitled '{title}'. \
+                The goal is assigned to {people} ({assignees}). \
+                Summarize the major developments, writing for general Rust users. \
+                Write the update in the third person and do not use pronouns when referring to people. \
+                Do not respond with anything but the summary paragraphs. \
+                ",
+                people = if issue.assignees.len() == 1 {
+                    "1 person".to_string()
+                } else {
+                    format!("{} people", issue.assignees.len())
+                },
+                assignees = comma(&issue.assignees),
+            );
+            let updates: String = comments.iter().map(|c| format!("\n{}\n", c.body)).collect();
+            llm.query(&prompt, &updates)
+                .await
+                .with_context(|| format!("making request to LLM failed"))?
+        };
+
+        updates.flagship_goals.push(UpdatesGoal {
             title: title.clone(),
             issue_number: issue.number,
             issue_assignees: comma(&issue.assignees),
@@ -144,17 +173,7 @@ async fn prepare_flagship_goals(
             .url(),
             progress,
             is_closed: issue.state == ExistingIssueState::Closed,
-            updates: issue
-                .comments
-                .iter()
-                .filter(|c| filter.matches(c))
-                .map(|c| UpdatesFlagshipGoalUpdate {
-                    author: c.author.clone(),
-                    date: c.created_at_date().format("%m %d").to_string(),
-                    update: c.body.clone(),
-                    url: c.url.clone(),
-                })
-                .collect(),
+            updates_markdown: summary,
         });
 
         progress_bar::inc_progress_bar();
@@ -219,7 +238,7 @@ async fn prepare_other_goals(
             llm.query(&prompt, &updates).await?
         };
 
-        let goal = UpdatesOtherGoal {
+        let goal = UpdatesGoal {
             title: title.clone(),
             issue_number: issue.number,
             issue_assignees: comma(&issue.assignees),

templates/updates.hbs

@@ -12,9 +12,10 @@ repository](https://github.com/rust-lang/rust-project-goals/milestone/2).
 
 {{!-- some spacing is required to ensure that markdown is recognized as markdown and not html --}}
 
-{{#each updates}}
-{{{update}}}
-{{/each}}
+{{{updates_markdown}}}
+
+{{!-- some spacing is required to ensure that markdown is recognized as markdown and not html --}}
+
 {{/each}}
 
 ## Goals with updates
@@ -26,6 +27,8 @@ repository](https://github.com/rust-lang/rust-project-goals/milestone/2).
 
 {{{updates_markdown}}}
 
+{{!-- some spacing is required to ensure that markdown is recognized as markdown and not html --}}
+
 {{/each}}
 
 ## Goals without updates