Help page redesign

docs/development.md

@@ -121,6 +121,12 @@ $ cargo sqlx prepare -- --all-targets
 
 After that, you should commit the changes to the `.sqlx` directory.
 
+## Updating commands
+When modifying commands, make sure to update both:
+
+1. The help page in `templates/help.html`
+2. The `@bors help` command output in `src/bors/handlers/help.rs`
+
 ## Logs in tests
 By default, logs are disabled in tests. To enable them, add `#[traced_test]`
 on top of the test function.

src/bin/bors.rs

@@ -131,7 +131,7 @@ fn try_main(opts: Opts) -> anyhow::Result<()> {
 
     let db = Arc::new(db);
     let ctx = BorsContext::new(
-        CommandParser::new(opts.cmd_prefix),
+        CommandParser::new(opts.cmd_prefix.clone()),
         db.clone(),
         repos.clone(),
     );
@@ -184,6 +184,7 @@ fn try_main(opts: Opts) -> anyhow::Result<()> {
         WebhookSecret::new(opts.webhook_secret),
         repos,
         db,
+        opts.cmd_prefix,
     );
     let server_process = webhook_server(state);
 

src/bors/command/mod.rs

@@ -63,6 +63,10 @@ impl FromStr for RollupMode {
 }
 
 /// Bors command specified by a user.
+///
+/// When modifying commands, remember to also update:
+/// - `templates/help.html` (HTML help page)
+/// - `src/bors/handlers/help.rs` (the `@bors help` command output)
 #[derive(Debug, PartialEq)]
 pub enum BorsCommand {
     /// Approve a commit.

src/bors/handlers/help.rs

@@ -53,6 +53,8 @@ You can use the following commands:
 - `r-`: Unapprove this PR
 - `p=<priority>` or `priority=<priority>`: Set the priority of this PR
 - `rollup=<never|iffy|maybe|always>`: Set the rollup status of the PR
+- `rollup`: Short for `rollup=always`
+- `rollup-`: Short for `rollup=maybe`
 - `delegate=<try|review>`: Delegate permissions for running try builds or approving to the PR author
     - `try` allows the PR author to start try builds.
     - `review` allows the PR author to both start try builds and approve the PR.
@@ -95,6 +97,8 @@ mod tests {
             - `r-`: Unapprove this PR
             - `p=<priority>` or `priority=<priority>`: Set the priority of this PR
             - `rollup=<never|iffy|maybe|always>`: Set the rollup status of the PR
+            - `rollup`: Short for `rollup=always`
+            - `rollup-`: Short for `rollup=maybe`
             - `delegate=<try|review>`: Delegate permissions for running try builds or approving to the PR author
                 - `try` allows the PR author to start try builds.
                 - `review` allows the PR author to both start try builds and approve the PR.

src/github/server.rs

@@ -41,6 +41,7 @@ pub struct ServerState {
     webhook_secret: WebhookSecret,
     repositories: HashMap<GithubRepoName, Arc<RepositoryState>>,
     db: Arc<PgDbClient>,
+    cmd_prefix: String,
 }
 
 impl ServerState {
@@ -50,19 +51,25 @@ impl ServerState {
         webhook_secret: WebhookSecret,
         repositories: HashMap<GithubRepoName, Arc<RepositoryState>>,
         db: Arc<PgDbClient>,
+        cmd_prefix: String,
     ) -> Self {
         Self {
             repository_event_queue,
             global_event_queue,
             webhook_secret,
             repositories,
             db,
+            cmd_prefix,
         }
     }
 
     pub fn get_webhook_secret(&self) -> &WebhookSecret {
         &self.webhook_secret
     }
+
+    pub fn get_cmd_prefix(&self) -> &str {
+        &self.cmd_prefix
+    }
 }
 
 pub type ServerStateRef = Arc<ServerState>;
@@ -113,7 +120,10 @@ async fn help_handler(State(state): State<ServerStateRef>) -> impl IntoResponse
         });
     }
 
-    HtmlTemplate(HelpTemplate { repos })
+    HtmlTemplate(HelpTemplate {
+        repos,
+        cmd_prefix: state.get_cmd_prefix().to_string(),
+    })
 }
 
 async fn queue_handler(

src/github/webhook.rs

@@ -513,6 +513,7 @@ mod tests {
     use crate::github::webhook::GitHubWebhook;
     use crate::github::webhook::WebhookSecret;
     use crate::tests::io::load_test_file;
+    use crate::tests::mocks::default_cmd_prefix;
     use crate::tests::webhook::{TEST_WEBHOOK_SECRET, create_webhook_request};
 
     #[tokio::test]
@@ -1613,6 +1614,7 @@ mod tests {
             WebhookSecret::new(TEST_WEBHOOK_SECRET.to_string()),
             repos,
             db,
+            default_cmd_prefix(),
         ));
         GitHubWebhook::from_request(request, &server_ref).await
     }

src/templates.rs

@@ -25,6 +25,7 @@ where
 #[template(path = "help.html")]
 pub struct HelpTemplate {
     pub repos: Vec<RepositoryView>,
+    pub cmd_prefix: String,
 }
 
 pub struct RepositoryView {

src/tests/mocks/bors.rs

@@ -30,6 +30,10 @@ use crate::tests::mocks::workflow::{
     CheckSuite, GitHubCheckRunEventPayload, GitHubCheckSuiteEventPayload,
     GitHubWorkflowEventPayload, TestWorkflowStatus, Workflow, WorkflowEvent, WorkflowEventKind,
 };
+
+pub fn default_cmd_prefix() -> String {
+    "@bors".to_string()
+}
 use crate::tests::mocks::{
     Branch, ExternalHttpMock, GitHubState, Repo, User, default_pr_number, default_repo_name,
 };
@@ -142,6 +146,7 @@ impl BorsTester {
             WebhookSecret::new(TEST_WEBHOOK_SECRET.to_string()),
             repos.clone(),
             db.clone(),
+            default_cmd_prefix(),
         );
         let app = create_app(state);
         let bors = tokio::spawn(bors_process);

src/tests/mocks/mod.rs

@@ -13,6 +13,7 @@ use crate::tests::mocks::github::GitHubMockServer;
 use crate::tests::mocks::permissions::TeamApiMockServer;
 
 pub use bors::BorsBuilder;
+pub use bors::default_cmd_prefix;
 pub use bors::run_test;
 pub use comment::Comment;
 pub use permissions::Permissions;

templates/base.html

@@ -4,9 +4,167 @@
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>{% block title %}{% endblock %}</title>
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Fira+Sans:ital,wght@0,300;0,400;0,500;0,600;0,700;1,300;1,400;1,500;1,600;1,700&family=Fira+Mono:wght@400;500;700&display=swap" rel="stylesheet">
+    <style>
+        *,
+        *::before,
+        *::after {
+            box-sizing: border-box;
+        }
+
+        * {
+            margin: 0;
+        }
+
+        body {
+            display: flex;
+            justify-content: center;
+            padding: var(--space-m);
+
+            line-height: 1.5;
+            font-family: "Fira Sans", sans-serif;
+            /* Improve text rendering for macOS */
+            -webkit-font-smoothing: antialiased;
+        }
+
+        html {
+            font-size: clamp(14px, 2.5vw, 16px);
+        }
+
+        input, button, textarea, select {
+          font: inherit;
+        }
+
+        /* Avoid text overflow */
+        p, h1, h2, h3, h4, h5, h6 {
+          overflow-wrap: break-word;
+        }
+
+        /* Improve line wrapping */
+        h1, h2, h3, h4, h5, h6 {
+          text-wrap: balance;
+        }
+
+        :root {
+            /* Spacing */
+            --space-4xs: 0.125rem;
+            --space-3xs: 0.25rem;
+            --space-2xs: 0.5rem;
+            --space-xs: 0.75rem;
+            --space-s: 1rem;
+            --space-m: 1.5rem;
+
+            /* Color palette */
+            --color-primary: #28607f;
+            --color-primary-hover: #3a7ba8;
+            --color-primary-active: #1e2650;
+
+            /* Code */
+            --color-code-bg: #f6f8fa;
+            --color-code-text: #383838;
+
+            /* Neutral colors */
+            --color-border-muted: #e1e4e8;
+            --color-text-muted: #a8b2bb;
+            --color-bg-higlight: #fafafa;
+
+            /* Typography */
+            --text-sm: 0.875rem;
+            --text-base: 1rem;
+            --text-lg: 1.125rem;
+            --text-xl: 1.25rem;
+            --text-2xl: 1.5rem;
+            --text-3xl: 1.875rem;
+
+            /* Radius */
+            --radius-sm: 0.25rem;
+        }
+
+        /* Typography */
+
+        h1 {
+            font-size: clamp(var(--text-2xl), 4vw, var(--text-3xl));
+            font-weight: 600;
+            line-height: 1.2;
+            margin-block-end: var(--space-s);
+        }
+
+        h2 {
+            font-size: clamp(var(--text-xl), 3vw, var(--text-2xl));
+            font-weight: 600;
+            line-height: 1.3;
+            margin-block: var(--space-m) var(--space-xs);
+        }
+
+        h3 {
+            font-size: clamp(var(--text-lg), 2.5vw, var(--text-xl));
+            font-weight: 500;
+            line-height: 1.4;
+            margin-block: var(--space-s) var(--space-2xs);
+        }
+
+        p {
+            font-size: var(--text-base);
+            margin-block-end: var(--space-s);
+        }
+
+        /* Links */
+
+        a {
+            color: var(--color-primary);
+            text-decoration: none;
+        }
+
+        a:hover {
+            color: var(--color-primary-hover);
+            text-decoration: underline;
+        }
+
+        a:active {
+            color: var(--color-primary-active);
+        }
+
+        a:focus-visible {
+            outline: 2px solid var(--color-primary);
+            outline-offset: 2px;
+            border-radius: var(--radius-sm);
+        }
+
+        code {
+            font-family: "Fira Mono", monospace;
+            font-size: var(--text-sm);
+            font-weight: 400;
+            background-color: var(--color-code-bg);
+            color: var(--color-code-text);
+            padding: var(--space-4xs) var(--space-3xs);
+            border-radius: var(--radius-sm);
+            overflow-wrap: break-word;
+            tab-size: 4;
+        }
+
+        /* Tables */
+
+        table {
+            font-size: var(--text-sm);
+            border-collapse: collapse;
+            inline-size: 100%;
+        }
+
+        th {
+            font-weight: 600;
+            text-align: start;
+        }
+
+        .empty::before {
+            content: "-";
+            color: var(--color-text-muted);
+        }
+    </style>
     {% block head %}{% endblock %}
   </head>
   <body>
     {% block body %}{% endblock %}
   </body>
-</html>
+</html>