Merge pull request #190 from nikomatsakis/normalize-team-asks

Normalize team asks

Author: nikomatsakis

Cargo.lock

@@ -23,6 +23,7 @@ command = "cargo run -p mdbook-goals --"
 [preprocessor.goals.users]
 "@Nadrieril" = "@Nadrieril"
 
+
 [output.html]
 git-repository-url = "https://github.com/rust-lang/rust-project-goals"
 edit-url-template = "https://github.com/rust-lang/rust-project-goals/edit/main/{path}"

book.toml

@@ -15,3 +15,4 @@ serde_json = "1.0.133"
 walkdir = "2.5.0"
 rust_team_data = { git = "https://github.com/rust-lang/team" }
 rust-project-goals-json = { version = "0.1.0", path = "../rust-project-goals-json" }
+toml = "0.8.19"

crates/rust-project-goals/Cargo.toml

@@ -0,0 +1,25 @@
+use std::{collections::BTreeMap, path::PathBuf};
+
+use anyhow::Context;
+use serde::Deserialize;
+
+#[derive(Deserialize)]
+pub struct Configuration {
+    pub team_asks: BTreeMap<String, String>,
+}
+
+impl Configuration {
+    pub fn get() -> &'static Configuration {
+        lazy_static::lazy_static! {
+            static ref CONFIG: Configuration = Configuration::load().unwrap();
+        }
+        &*CONFIG
+    }
+
+    fn load() -> anyhow::Result<Configuration> {
+        let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
+        let toml_file = manifest_dir.join("../../rust-project-goals.toml");
+        let toml_string = std::fs::read_to_string(&toml_file).with_context(|| format!("loading configuration from {}", toml_file.display()))?;
+        Ok(toml::from_str(&toml_string)?)
+    }
+}

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

@@ -3,9 +3,10 @@ use std::path::Path;
 use std::sync::Arc;
 use std::{collections::BTreeSet, path::PathBuf};
 
-use anyhow::Context;
+use anyhow::{bail, Context};
 use regex::Regex;
 
+use crate::config::Configuration;
 use crate::gh::issue_id::{IssueId, Repository};
 use crate::markwaydown::{self, Section, Table};
 use crate::re::USERNAME;
@@ -353,7 +354,7 @@ fn extract_metadata(sections: &[Section]) -> anyhow::Result<Option<Metadata>> {
     else {
         anyhow::bail!("metadata table has no `Owner(s)` row")
     };
-
+ 
     let Some(status_row) = first_table.rows.iter().find(|row| row[0] == "Status") else {
         anyhow::bail!("metadata table has no `Status` row")
     };
@@ -524,6 +525,16 @@ impl PlanItem {
 
         let teams = self.teams_being_asked()?;
         if !teams.is_empty() {
+            let config = Configuration::get();
+            if !config.team_asks.contains_key(&self.text) {
+                bail!("unrecognized team ask {:?}, team asks must be one of the following:\n{}",
+                    self.text,
+                    config.team_asks.iter().map(|(ask, explanation)| {
+                        format!("* {ask:?}, meaning team should {explanation}")
+                    }).collect::<Vec<_>>().join("\n"),
+                );
+            }
+
             asks.push(TeamAsk {
                 link_path: link_path.clone(),
                 ask_description: self.text.clone(),

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

@@ -4,3 +4,4 @@ pub mod markwaydown;
 pub mod re;
 pub mod team;
 pub mod util;
+pub mod config;

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

@@ -0,0 +1,21 @@
+# Configuration for the project-goals code
+
+[team_asks]
+"Allocate funds" = "allocate funding"
+"Discussion and moral support" = "approve of this direction and be prepared for light discussion on Zulip or elsewhere"
+"Design meeting" = "hold a synchronous meeting to review a proposal and provide feedback (no decision expected)"
+"Stabilization decision" = "reach a decision on a stabilization proposal"
+"Prioritized nominations" = "prioritize discussion and resolution of nominated issues"
+"Deploy to production" = "deploy code to production (e.g., on crates.io"
+"Standard reviews" = "review PRs (PRs are not expected to be unduly large or complicated)"
+"Dedicated reviewer" = "assign a specific person (or people) to review a series of PRs, appropriate for large or complex asks"
+"Lang-team experiment" = "begin a [lang-team experiment](https://lang-team.rust-lang.org/how_to/experiment.html) authorizing experimental impl of lang changes before an RFC is written; limited to trusted contributors"
+"RFC decision" = "review an RFC and deciding whether to accept"
+"RFC secondary review" = "briefly review an RFC without need of a formal decision"
+"Org decision" = "reach a decision on an organizational or policy matter"
+"MCP decision" = "accept a [Major Change Proposal](https://forge.rust-lang.org/compiler/mcp.html)"
+"ACP decision" = "accept an [API Change Proposal](https://std-dev-guide.rust-lang.org/development/feature-lifecycle.html)"
+"Policy decision" = "make a decision related to team policy"
+"FCP decision(s)" = "make formal decision(s) that require 'checkboxes' and a FCP (Final Comment Period)"
+"Blog post approval" = "approve of posting about this on the main Rust blog"
+"Miscellaneous" = "do some one-off action as described in the notes"

gh-cache/@tautschnig.bincode

@@ -1,7 +1,7 @@
 # Associated type position impl trait
 
 | Metadata       |                                    |
-| ---            | ---                                |
+|----------------|------------------------------------|
 | Owner(s)       | @oli-obk                           |
 | Teams          | [types], [lang]                    |
 | Status         | Accepted                           |
@@ -61,9 +61,9 @@ None.
 **Owner:** oli-obk owns this goal.
 
 | Subgoal                | Owner(s) or team(s)      | Notes |
-| ---------------------- | ------------------------ | ----- |
+|------------------------|--------------------------|-------|
 | Implementation         | @oli-obk                 |       |
-| FCP decisions          | ![Team][] [types]        |       |
+| FCP decision(s)           | ![Team][] [types]        |       |
 | Stabilization decision | ![Team][] [types] [lang] |       |
 
 ## Frequently asked questions