Handle ability to change milestone (#249)

* Handle ability to change milestone

* Comment on issue when changing milestone

* Extract list_issues with a filter fn

* Make lock_issue reuse create_comment code

* Milestone dueOn could be null

Author: spastorino

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

@@ -13,7 +13,8 @@ use rust_project_goals::{
     gh::{
         issue_id::{IssueId, Repository},
         issues::{
-            create_issue, list_issues_in_milestone, lock_issue, sync_assignees, FLAGSHIP_LABEL,
+            change_milestone, create_comment, create_issue, list_tracking_issues, lock_issue,
+            sync_assignees, FLAGSHIP_LABEL, LOCK_TEXT,
         },
         labels::GhLabel,
     },
@@ -177,6 +178,16 @@ enum GithubAction<'doc> {
         issue: GithubIssue<'doc>,
     },
 
+    ChangeMilestone {
+        number: u64,
+        milestone: String,
+    },
+
+    Comment {
+        number: u64,
+        body: String,
+    },
+
     // We intentionally do not sync the issue *text*, because it may have been edited.
     SyncAssignees {
         number: u64,
@@ -248,7 +259,8 @@ fn initialize_issues<'doc>(
         .collect::<anyhow::Result<_>>()?;
 
     // Compare desired issues against existing issues
-    let existing_issues = list_issues_in_milestone(repository, timeframe)?;
+    let existing_issues = list_tracking_issues(repository)?;
+
     let mut actions = BTreeSet::new();
     for desired_issue in desired_issues {
         match existing_issues.iter().find(|issue| {
@@ -272,10 +284,29 @@ fn initialize_issues<'doc>(
                     });
                 }
 
+                if existing_issue.milestone.as_ref().map(|m| m.title.as_str()) != Some(timeframe) {
+                    actions.insert(GithubAction::ChangeMilestone {
+                        number: existing_issue.number,
+                        milestone: timeframe.to_string(),
+                    });
+                    actions.insert(GithubAction::Comment {
+                        number: existing_issue.number,
+                        body: format!(
+                            "This is a continuing project goal, and the updates below \
+                            this comment will be for the new period {}",
+                            timeframe
+                        ),
+                    });
+                }
+
                 if !existing_issue.was_locked() {
                     actions.insert(GithubAction::LockIssue {
                         number: existing_issue.number,
                     });
+                    actions.insert(GithubAction::Comment {
+                        number: existing_issue.number,
+                        body: LOCK_TEXT.to_string(),
+                    });
                 }
 
                 let issue_id = IssueId::new(repository.clone(), existing_issue.number);
@@ -419,6 +450,12 @@ impl Display for GithubAction<'_> {
             GithubAction::CreateIssue { issue } => {
                 write!(f, "create issue \"{}\"", issue.title)
             }
+            GithubAction::ChangeMilestone { number, milestone } => {
+                write!(f, "update issue #{} milestone to \"{}\"", number, milestone)
+            }
+            GithubAction::Comment { number, body } => {
+                write!(f, "post comment on issue #{}: \"{}\"", number, body)
+            }
             GithubAction::SyncAssignees {
                 number,
                 remove_owners,
@@ -478,6 +515,17 @@ impl GithubAction<'_> {
 
                 Ok(())
             }
+
+            GithubAction::ChangeMilestone { number, milestone } => {
+                change_milestone(repository, number, &milestone)?;
+                Ok(())
+            }
+
+            GithubAction::Comment { number, body } => {
+                create_comment(repository, number, &body)?;
+                Ok(())
+            }
+
             GithubAction::SyncAssignees {
                 number,
                 remove_owners,

crates/rust-project-goals/src/gh.rs

@@ -5,3 +5,4 @@
 pub mod issue_id;
 pub mod issues;
 pub mod labels;
+pub mod milestone;

crates/rust-project-goals/src/gh/issues.rs

@@ -7,7 +7,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::{re, util::comma};
 
-use super::{issue_id::Repository, labels::GhLabel};
+use super::{issue_id::Repository, labels::GhLabel, milestone::GhMilestone};
 
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
 pub struct ExistingGithubIssue {
@@ -19,6 +19,7 @@ pub struct ExistingGithubIssue {
     pub body: String,
     pub state: GithubIssueState,
     pub labels: Vec<GhLabel>,
+    pub milestone: Option<GhMilestone>,
 }
 
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
@@ -39,6 +40,7 @@ struct ExistingGithubIssueJson {
     body: String,
     state: GithubIssueState,
     labels: Vec<GhLabel>,
+    milestone: Option<GhMilestone>,
 }
 
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
@@ -122,17 +124,34 @@ pub fn list_issues_in_milestone(
     repository: &Repository,
     timeframe: &str,
 ) -> anyhow::Result<Vec<ExistingGithubIssue>> {
-    let output = Command::new("gh")
-        .arg("-R")
+    list_issues(repository, &[("-m", timeframe)])
+}
+
+pub fn list_tracking_issues(repository: &Repository) -> anyhow::Result<Vec<ExistingGithubIssue>> {
+    list_issues(repository, &[("-l", "C-tracking-issue")])
+}
+
+pub fn list_issues(
+    repository: &Repository,
+    filter: &[(&str, &str)],
+) -> anyhow::Result<Vec<ExistingGithubIssue>> {
+    let mut cmd = Command::new("gh");
+
+    cmd.arg("-R")
         .arg(&repository.to_string())
         .arg("issue")
         .arg("list")
-        .arg("-m")
-        .arg(timeframe)
         .arg("-s")
-        .arg("all")
+        .arg("all");
+
+    for (opt, val) in filter {
+        cmd.arg(opt);
+        cmd.arg(val);
+    }
+
+    let output = cmd
         .arg("--json")
-        .arg("title,assignees,number,comments,body,state,labels")
+        .arg("title,assignees,number,comments,body,state,labels,milestone")
         .output()
         .with_context(|| format!("running github cli tool `gh`"))?;
 
@@ -180,6 +199,55 @@ pub fn create_issue(
     }
 }
 
+pub fn change_milestone(
+    repository: &Repository,
+    number: u64,
+    milestone: &str,
+) -> anyhow::Result<()> {
+    let mut command = Command::new("gh");
+    command
+        .arg("-R")
+        .arg(&repository.to_string())
+        .arg("issue")
+        .arg("edit")
+        .arg(number.to_string())
+        .arg("-m")
+        .arg(milestone);
+
+    let output = command.output()?;
+    if !output.status.success() {
+        Err(anyhow::anyhow!(
+            "failed to change milestone `{}`: {}",
+            number,
+            String::from_utf8_lossy(&output.stderr)
+        ))
+    } else {
+        Ok(())
+    }
+}
+
+pub fn create_comment(repository: &Repository, number: u64, body: &str) -> anyhow::Result<()> {
+    let output = Command::new("gh")
+        .arg("-R")
+        .arg(&repository.to_string())
+        .arg("issue")
+        .arg("comment")
+        .arg(number.to_string())
+        .arg("-b")
+        .arg(body)
+        .output()?;
+
+    if !output.status.success() {
+        Err(anyhow::anyhow!(
+            "failed to leave comment on issue `{}`: {}",
+            number,
+            String::from_utf8_lossy(&output.stderr)
+        ))
+    } else {
+        Ok(())
+    }
+}
+
 pub fn sync_assignees(
     repository: &Repository,
     number: u64,
@@ -216,7 +284,7 @@ pub fn sync_assignees(
 
 pub const FLAGSHIP_LABEL: &str = "Flagship Goal";
 
-const LOCK_TEXT: &str = "This issue is intended for status updates only.\n\nFor general questions or comments, please contact the owner(s) directly.";
+pub const LOCK_TEXT: &str = "This issue is intended for status updates only.\n\nFor general questions or comments, please contact the owner(s) directly.";
 
 impl ExistingGithubIssue {
     /// We use the presence of a "lock comment" as a signal that we successfully locked the issue.
@@ -255,25 +323,6 @@ pub fn lock_issue(repository: &Repository, number: u64) -> anyhow::Result<()> {
         }
     }
 
-    // Leave a comment explaining what is going on.
-    let output = Command::new("gh")
-        .arg("-R")
-        .arg(&repository.to_string())
-        .arg("issue")
-        .arg("comment")
-        .arg(number.to_string())
-        .arg("-b")
-        .arg(LOCK_TEXT)
-        .output()?;
-
-    if !output.status.success() {
-        return Err(anyhow::anyhow!(
-            "failed to leave lock comment `{}`: {}",
-            number,
-            String::from_utf8_lossy(&output.stderr)
-        ));
-    }
-
     Ok(())
 }
 
@@ -308,6 +357,7 @@ impl From<ExistingGithubIssueJson> for ExistingGithubIssue {
             body: e_i.body,
             state: e_i.state,
             labels: e_i.labels,
+            milestone: e_i.milestone,
         }
     }
 }

crates/rust-project-goals/src/gh/milestone.rs

@@ -0,0 +1,10 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
+pub struct GhMilestone {
+    pub number: u64,
+    pub title: String,
+    pub description: String,
+    #[serde(rename = "dueOn")]
+    pub due_on: Option<String>,
+}