feat: add Octoguide (#2220)

## PR Checklist

- [x] Addresses an existing open issue: fixes #2219
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Adds [Octoguide](https://octo.guide) as a new `--add-octoguide` Block.
This replaces two existing bot workflows:

* `accessibility-alt-text-bot.yml`: which was previously always included
by default
* `compliance.yml`: which was `--add-pr-compliance` and enabled in the
_everything_ preset

OctoGuide is now enabled in the _common_ preset, with its `strict`
config enabled with `--add-octoguide-strit` in _everything_.

🎁

Author: JoshuaKGoldberg

.github/workflows/accessibility-alt-text-bot.yml

@@ -0,0 +1,45 @@
+jobs:
+  octoguide:
+    if: ${{ !endsWith(github.actor, '[bot]') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JoshuaKGoldberg/octoguide@0.11.1
+        with:
+          config: strict
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+name: OctoGuide
+
+on:
+  discussion:
+    types:
+      - created
+      - edited
+  discussion_comment:
+    types:
+      - created
+      - deleted
+      - edited
+  issue_comment:
+    types:
+      - created
+      - deleted
+      - edited
+  issues:
+    types:
+      - edited
+      - opened
+  pull_request_review_comment:
+    types:
+      - created
+      - deleted
+      - edited
+  pull_request_target:
+    types:
+      - edited
+      - opened
+
+permissions:
+  discussions: write
+  issues: write
+  pull-requests: write

.github/workflows/compliance.yml

@@ -21,8 +21,8 @@
 		"joshuakgoldberg",
 		"markdownlintignore",
 		"mshick",
-		"mtfoley",
 		"npmjs",
+		"octoguide",
 		"stefanzweifel"
 	]
 }

.github/workflows/octoguide.yml

@@ -37,9 +37,10 @@ This table summarizes each block and which base levels they're included in:
 | MIT License                  | `--add-mit-license`, `--exclude-mit-license`                                   | ✔️      | ✅     | 💯         |
 | ncc                          | `--add-ncc`, `--exclude-ncc`                                                   |         |        |            |
 | nvmrc                        | `--add-nvmrc`, `--exclude-nvmrc`                                               |         |        | 💯         |
+| OctoGuide                    | `--add-octoguide`, `--exclude-octoguide`                                       |         | ✅     | 💯         |
+| OctoGuide Strict             | `--add-octoguide-strict`, `--exclude-octoguide-strict`                         |         |        | 💯         |
 | Package JSON                 | `--add-package-json`, `--exclude-package-json`                                 | ✔️      | ✅     | 💯         |
 | pnpm Dedupe                  | `--add-pnpm-dedupe`, `--exclude-pnpm-dedupe`                                   |         |        | 💯         |
-| PR Compliance                | `--add-pr-compliance`, `--exclude-pr-compliance`                               |         |        | 💯         |
 | Prettier                     | `--add-prettier`, `--exclude-prettier`                                         | ✔️      | ✅     | 💯         |
 | Prettier Plugin Curly        | `--add-prettier-plugin-curly`, `--exclude-prettier-plugin-curly`               |         |        | 💯         |
 | Prettier Plugin Package JSON | `--add-prettier-plugin-package-json`, `--exclude-prettier-plugin-package-json` |         |        | 💯         |
@@ -176,6 +177,7 @@ This is recommended for most users of `create-typescript-app` to start with.
 
 - [Contributors](#contributors)
 - [Lint Knip](#lint-knip)
+- [OctoGuide](#octoguide)
 - [Releases](#releases)
 - [Renovate](#renovate)
 - [Testing](#testing)
@@ -195,6 +197,11 @@ Running Knip:
 pnpm run lint:knip
 ```
 
+### OctoGuide
+
+[**OctoGuide**](https://octo.guide): checks that contributor activity on your GitHub repository aligns with common expectations of smoothly-running projects.
+It will automatically post friendly comments when contributors take actions you don’t want them to.
+
 ### Releases
 
 [**release-it**](https://github.com/release-it/release-it): Generates changelogs, bumps the package version, and publishes to GitHub and npm based on [conventional commits](https://www.conventionalcommits.org).
@@ -235,7 +242,6 @@ pnpm run test run --coverage
 This level is for developers who are eager to get the maximum tooling benefits in a repository.
 Using the _"everything"_ level will gain you comprehensive, strict coverage of all sorts of repository issues, including auto-sorting of properties and strict ESLint configs.
 
-- [Compliance](#compliance)
 - [Lint ESLint](#lint-eslint)
 - [Lint JSDoc](#lint-jsdoc)
 - [Lint JSON](#lint-json)
@@ -248,10 +254,7 @@ Using the _"everything"_ level will gain you comprehensive, strict coverage of a
 - [Lint Strict](#lint-strict)
 - [Lint Stylistic](#lint-stylistic)
 - [Lint YML](#lint-yml)
-
-### Compliance
-
-[**PR Compliance Action**](https://github.com/mtfoley/pr-compliance-action): Checks PRs for compliance such as addressing a linked issue and proper title formatting.
+- [OctoGuide Strict](#octoguide-strict)
 
 ### Lint ESLint
 
@@ -320,3 +323,7 @@ Enables [typescript-eslint's stylistic configs](https://typescript-eslint.io/lin
 ### Lint YML
 
 [`eslint-plugin-yml`](https://ota-meshi.github.io/eslint-plugin-yml): Adds linting for `yaml` and `.yml` files, such as sorting keys.
+
+### OctoGuide Strict
+
+[**OctoGuide's Strict Config**](https://octo.guide/configs#rules-table): additionally enforces enforcing semantic pull request conventions.

cspell.json

@@ -0,0 +1,38 @@
+import { IntakeDirectory } from "bingo-fs";
+import _ from "lodash";
+import { z } from "zod";
+
+import { intakeFileAsYaml } from "../intake/intakeFileAsYaml.js";
+
+export const zActionStep = z.intersection(
+	z.object({
+		env: z.record(z.string(), z.string()).optional(),
+		if: z.string().optional(),
+		with: z.record(z.string(), z.string()).optional(),
+	}),
+	z.union([z.object({ run: z.string() }), z.object({ uses: z.string() })]),
+);
+
+export interface JobOrRunStep {
+	env?: Record<string, string>;
+	uses?: unknown;
+	with?: Record<string, string>;
+}
+
+export function intakeFileYamlSteps(
+	files: IntakeDirectory,
+	filePath: string[],
+	ymlPath: string[],
+) {
+	const actionYml = intakeFileAsYaml(files, filePath);
+	if (!actionYml) {
+		return undefined;
+	}
+
+	const steps = _.get(actionYml, ymlPath) as JobOrRunStep[] | undefined;
+	if (!steps || !Array.isArray(steps)) {
+		return undefined;
+	}
+
+	return steps;
+}

docs/Blocks.md

@@ -1,18 +1,12 @@
-import _ from "lodash";
 import { z } from "zod";
 
 import { base } from "../base.js";
 import { resolveUses } from "./actions/resolveUses.js";
+import { intakeFileYamlSteps } from "./actions/steps.js";
 import { blockGitHubApps } from "./blockGitHubApps.js";
 import { blockREADME } from "./blockREADME.js";
 import { blockRemoveFiles } from "./blockRemoveFiles.js";
 import { blockVitest } from "./blockVitest.js";
-import { intakeFileAsYaml } from "./intake/intakeFileAsYaml.js";
-
-interface JobStep {
-	env?: Record<string, string>;
-	uses?: unknown;
-}
 
 export const blockCodecov = base.createBlock({
 	about: {
@@ -22,14 +16,11 @@ export const blockCodecov = base.createBlock({
 		env: z.record(z.string(), z.string()).optional(),
 	},
 	intake({ files }) {
-		const ciYaml = intakeFileAsYaml(files, [".github", "workflows", "ci.yml"]);
-		if (!ciYaml) {
-			return undefined;
-		}
-
-		const steps = _.get(ciYaml, ["jobs", "test", "steps"]) as
-			| JobStep[]
-			| undefined;
+		const steps = intakeFileYamlSteps(
+			files,
+			[".github", "workflows", "ci.yml"],
+			["jobs", "test", "steps"],
+		);
 		if (!steps) {
 			return undefined;
 		}