Merge pull request #426 from tomassedovic/recent-reports

Replace monthly reports with "recent updates"

Author: nikomatsakis

crates/mdbook-goals/src/mdbook_preprocessor.rs

@@ -13,6 +13,7 @@ use rust_project_goals::format_champions::format_champions;
 use rust_project_goals::format_team_ask::format_team_asks;
 use rust_project_goals::markdown_processor::{MarkdownProcessor, MarkdownProcessorState};
 use rust_project_goals::util;
+use rust_project_goals_cli::Order;
 
 use rust_project_goals::spanned::Spanned;
 use rust_project_goals::{
@@ -611,7 +612,7 @@ impl<'c> GoalPreprocessorWithContext<'c> {
             let team_virtual_path = format!("{}/index.md", team_name_str);
             let team_path = Path::new(&team_virtual_path);
 
-            let team_content = format!("# {} Team Champion Reports\n\nThis section contains monthly champion reports for the {} team.", team_name_str, team_name_str);
+            let team_content = format!("# {} Team Champion Reports\n\nThis section contains champion reports for the {} team.", team_name_str, team_name_str);
             let mut team_chapter = Chapter::new(
                 &team_chapter_name,
                 team_content,
@@ -627,36 +628,34 @@ impl<'c> GoalPreprocessorWithContext<'c> {
 
             let mut team_parent_names = parent_names.clone();
             team_parent_names.push(team_chapter_name.clone());
-            let mut team_sub_index = 1;
-
-            // Generate monthly reports for this team
-            for (year, month, month_name) in months.iter().rev() {
-                // Reverse to show newest first
-                let champion_content =
-                    self.generate_champion_report_content(milestone, team_name_str, *year, *month)?;
-
-                let monthly_chapter_name = format!("{} {}", month_name, year);
-                let monthly_virtual_path = format!("{}/{:04}-{:02}.md", team_name_str, year, month);
-                let monthly_path = Path::new(&monthly_virtual_path);
-
-                let mut monthly_chapter = Chapter::new(
-                    &monthly_chapter_name,
-                    champion_content,
-                    monthly_path,
-                    team_parent_names.clone(),
-                );
-
-                if let Some(mut number) = team_chapter.number.clone() {
-                    number.0.push(team_sub_index);
-                    monthly_chapter.number = Some(number);
-                    team_sub_index += 1;
-                }
+            let team_sub_index = 1;
+
+            // Generate the "recent updates" report for this team
+
+            // Reverse to show newest first
+            let champion_content =
+                self.generate_champion_report_content(milestone, team_name_str)?;
+
+            let report_name = format!("Recent updates");
+            let report_virtual_path = format!("{team_name_str}/recent-updates.md");
+            let report_path = Path::new(&report_virtual_path);
+
+            let mut report_chapter = Chapter::new(
+                &report_name,
+                champion_content,
+                report_path,
+                team_parent_names.clone(),
+            );
 
-                team_chapter
-                    .sub_items
-                    .push(BookItem::Chapter(monthly_chapter));
+            if let Some(mut number) = team_chapter.number.clone() {
+                number.0.push(team_sub_index);
+                report_chapter.number = Some(number);
             }
 
+            team_chapter
+                .sub_items
+                .push(BookItem::Chapter(report_chapter));
+
             parent_chapter
                 .sub_items
                 .push(BookItem::Chapter(team_chapter));
@@ -704,6 +703,7 @@ impl<'c> GoalPreprocessorWithContext<'c> {
             &Some(end_date),
             None,
             false,
+	    Order::OldestFirst,
         )
         .map_err(|e| anyhow::anyhow!("Failed to generate blog post content: {}", e))?;
 
@@ -714,26 +714,16 @@ impl<'c> GoalPreprocessorWithContext<'c> {
         &mut self,
         milestone: &str,
         team_name: &str,
-        year: i32,
-        month: u32,
     ) -> anyhow::Result<String> {
-        use chrono::NaiveDate;
+	// Look at the updates for the last ~three months
+	let end_date = chrono::Utc::now().date_naive();
+	let start_date = end_date - chrono::TimeDelta::days(90);
 
         eprintln!(
-            "👥 Generating champion report for {} team, {}-{:02} (milestone: {})",
-            team_name, year, month, milestone
+            "👥 Generating champion report for {} team, {start_date} - {end_date} (milestone: {})",
+            team_name, milestone
         );
 
-        // Calculate start and end dates for the month
-        let start_date = NaiveDate::from_ymd_opt(year, month, 1)
-            .ok_or_else(|| anyhow::anyhow!("Invalid date: {}-{:02}-01", year, month))?;
-        let end_date = if month == 12 {
-            NaiveDate::from_ymd_opt(year + 1, 1, 1)
-        } else {
-            NaiveDate::from_ymd_opt(year, month + 1, 1)
-        }
-        .ok_or_else(|| anyhow::anyhow!("Invalid end date calculation for {}-{:02}", year, month))?;
-
         // Get repository from context - assuming rust-lang/rust-project-goals as default
         let repository =
             rust_project_goals::gh::issue_id::Repository::new("rust-lang", "rust-project-goals");
@@ -750,6 +740,7 @@ impl<'c> GoalPreprocessorWithContext<'c> {
             &Some(end_date),
             Some(team_name),
             false,
+	    Order::NewestFirst,
         )
         .map_err(|e| anyhow::anyhow!("Failed to generate champion report content: {}", e))?;
 

crates/rust-project-goals-cli/src/lib.rs

@@ -1,3 +1,3 @@
 pub mod updates;
 
-pub use updates::render_updates;
+pub use updates::{Order, render_updates};

crates/rust-project-goals-cli/src/main.rs

@@ -238,6 +238,7 @@ fn generate_updates(
         end_date,
         with_champion_from,
         true,
+	updates::Order::default(),
     )?;
 
     if let Some(output_file) = output_file {

crates/rust-project-goals-cli/src/updates.rs

@@ -15,6 +15,18 @@ use rust_project_goals::gh::{
 };
 use templates::{HelpWanted, UpdatesGoal};
 
+#[derive(Copy, Clone, Default)]
+/// Order in which GitHub comments for each goal are displayed.
+pub enum Order {
+    #[default]
+    /// Chronological order: the oldest comments show up first.
+    /// Mirrors the order on the corresponding GitHub issue.
+    OldestFirst,
+
+    /// Reverse chronological order: the most recent comments will show up first.
+    NewestFirst,
+}
+
 /// Library function that renders updates as a string without side effects.
 /// This is suitable for use from the mdbook preprocessor.
 pub fn render_updates(
@@ -25,6 +37,7 @@ pub fn render_updates(
     end_date: &Option<NaiveDate>,
     with_champion_from: Option<&str>,
     use_progress_bar: bool,
+    comment_order: Order,
 ) -> Result<String> {
     let milestone_re = Regex::new(r"^\d{4}[hH][12]$").unwrap();
     if !milestone_re.is_match(milestone) {
@@ -167,6 +180,7 @@ pub fn render_updates(
         &filter,
         true,
         use_progress_bar,
+	comment_order,
         &issue_themes,
         &issue_point_of_contact,
         &issue_team_champions,
@@ -178,6 +192,7 @@ pub fn render_updates(
         &filter,
         false,
         use_progress_bar,
+	comment_order,
         &issue_themes,
         &issue_point_of_contact,
         &issue_team_champions,
@@ -199,6 +214,7 @@ fn prepare_goals(
     filter: &Filter<'_>,
     flagship: bool,
     use_progress_bar: bool,
+    comment_order: Order,
     issue_themes: &std::collections::HashMap<u64, String>,
     issue_point_of_contact: &std::collections::HashMap<u64, String>,
     issue_team_champions: &std::collections::HashMap<u64, String>,
@@ -233,6 +249,11 @@ fn prepare_goals(
         comments.sort_by_key(|c| c.created_at.clone());
         comments.retain(|c| !c.should_hide_from_reports() && filter.matches(c));
 
+	// We got the comments in the chronological order. Reverse it if desired.
+	if matches!(comment_order, Order::NewestFirst) {
+            comments.reverse();
+	}
+
         // Prettify the comments' timestamp after using it for sorting.
         for comment in comments.iter_mut() {
             comment.created_at = format!("{}", comment.created_at_date());