Merge pull request #136 from nikomatsakis/status-updates

code to generate status updates

Author: nikomatsakis

Cargo.lock

@@ -17,3 +17,4 @@ walkdir = "2.5.0"
 rust_team_data = { git = "https://github.com/rust-lang/team" }
 lazy_static = "1.5.0"
 progress_bar = "1.0.5"
+chrono = "0.4.38"

mdbook-goals/Cargo.toml

@@ -3,6 +3,7 @@ use std::{
     process::Command,
 };
 
+use chrono::NaiveDate;
 use serde::{Deserialize, Serialize};
 
 use crate::util::comma;
@@ -67,6 +68,15 @@ pub enum ExistingIssueState {
     Closed,
 }
 
+impl std::fmt::Display for ExistingIssueState {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            ExistingIssueState::Open => write!(f, "open"),
+            ExistingIssueState::Closed => write!(f, "closed"),
+        }
+    }
+}
+
 pub fn list_issue_titles_in_milestone(
     repository: &str,
     timeframe: &str,
@@ -239,4 +249,9 @@ impl ExistingGithubComment {
     pub fn is_automated_comment(&self) -> bool {
         self.body.trim() == LOCK_TEXT
     }
+
+    pub fn created_at_date(&self) -> NaiveDate {
+        NaiveDate::parse_from_str(&self.created_at, "%Y-%m-%dT%H:%M:%SZ")
+            .expect("failed to parse date")
+    }
 }

mdbook-goals/src/gh/issues.rs

@@ -16,6 +16,7 @@ mod re;
 mod rfc;
 mod team;
 mod team_repo;
+mod updates;
 mod util;
 
 #[derive(StructOpt, Debug)]
@@ -80,6 +81,21 @@ enum Command {
         #[structopt(long)]
         json_path: Option<PathBuf>,
     },
+
+    /// Generate markdown with the list of updates for each tracking issue.
+    /// Collects updates
+    Updates {
+        /// Milestone for which we generate tracking issue data (e.g., `2024h2`).
+        milestone: String,
+
+        /// Start date for comments.
+        /// If not given, defaults to 1 week before the start of this month.
+        start_date: Option<chrono::NaiveDate>,
+
+        /// End date for comments.
+        /// If not given, no end date.
+        end_date: Option<chrono::NaiveDate>,
+    },
 }
 
 fn main() -> anyhow::Result<()> {
@@ -128,6 +144,13 @@ fn main() -> anyhow::Result<()> {
         } => {
             json::generate_json(&opt.repository, &milestone, json_path)?;
         }
+        Command::Updates {
+            milestone,
+            start_date,
+            end_date,
+        } => {
+            updates::updates(&opt.repository, milestone, start_date, end_date)?;
+        }
     }
 
     Ok(())

mdbook-goals/src/main.rs

@@ -0,0 +1,98 @@
+use chrono::{Datelike, NaiveDate};
+
+use crate::{
+    gh::issues::{list_issue_titles_in_milestone, ExistingGithubComment},
+    util::comma,
+};
+
+pub fn updates(
+    repo: &str,
+    milestone: &str,
+    start_date: &Option<NaiveDate>,
+    end_date: &Option<NaiveDate>,
+) -> anyhow::Result<()> {
+    let issues = list_issue_titles_in_milestone(repo, milestone)?;
+
+    let filter = Filter {
+        start_date: match start_date {
+            Some(date) => date.clone(),
+            None => default_start_date(),
+        },
+        end_date,
+    };
+
+    for (title, issue) in issues {
+        let total_updates = issue
+            .comments
+            .iter()
+            .filter(|c| !c.is_automated_comment())
+            .count();
+
+        println!(
+            "# {title} (#{number})",
+            title = title,
+            number = issue.number
+        );
+        println!("");
+        println!("| Metadata | |");
+        println!("| --- | --- |");
+        println!(
+            "| Assigned to | {assignees} |",
+            assignees = comma(&issue.assignees),
+        );
+        println!("| State | {state} |", state = issue.state);
+        println!("| Total updates | {total_updates} |");
+        println!(
+            "| Date of most recent update | {date} |",
+            date = issue
+                .comments
+                .last()
+                .map(|c| c.created_at_date().to_string())
+                .unwrap_or("none".to_string())
+        );
+
+        let mut comments = issue.comments;
+        comments.sort_by_key(|c| c.created_at.clone());
+        comments.retain(|c| filter.matches(c));
+
+        println!();
+        if comments.len() == 0 {
+            println!("No updates since {date}.", date = filter.start_date);
+        } else {
+            for comment in comments {
+                println!(
+                    "## Update by {author} from {created} ([link]({url}))",
+                    author = comment.author,
+                    created = comment.created_at_date(),
+                    url = comment.url,
+                );
+                println!("\n{body}\n", body = comment.body);
+            }
+        }
+    }
+
+    Ok(())
+}
+
+struct Filter<'f> {
+    start_date: NaiveDate,
+    end_date: &'f Option<NaiveDate>,
+}
+
+impl Filter<'_> {
+    fn matches(&self, comment: &ExistingGithubComment) -> bool {
+        let date = comment.created_at_date();
+
+        date >= self.start_date
+            && match self.end_date {
+                Some(end_date) => date <= *end_date,
+                None => true,
+            }
+    }
+}
+
+fn default_start_date() -> NaiveDate {
+    let date = chrono::Utc::now().date_naive();
+    let start_of_month = NaiveDate::from_ymd_opt(date.year(), date.month(), 1).unwrap();
+    start_of_month - chrono::Duration::days(7)
+}