Show comments in team reports in reverse chronological order

This introduces the `Order` enum which lets you choose between
displaying GitHub comments ("detailed updates") in either
chronological (oldest first i.e. what we used to do until now) or
reverse chronological (newest first) order.

The team reports now show updates in the reverse chronological order
-- so that you can more easily look at the new stuff that was added.

Everything else (e.g. the blog posts) still uses the regular
chronological order.

Author: tomassedovic

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::{
@@ -704,6 +705,7 @@ impl<'c> GoalPreprocessorWithContext<'c> {
             &Some(end_date),
             None,
             false,
+	    Order::OldestFirst,
         )
         .map_err(|e| anyhow::anyhow!("Failed to generate blog post content: {}", e))?;
 
@@ -750,6 +752,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());