cloudflare--workers-sdk/tools/deployments/validate-pr-description.ts

/* eslint-disable turbo/no-undeclared-env-vars -- this script reads CI environment variables */
if (require.main === module) {
	const errors = validateDescription(
		process.env.TITLE as string,
		process.env.BODY as string,
		process.env.LABELS as string,
		process.env.FILES as string
	);
	if (errors.length > 0) {
		console.error("Validation errors in PR description:");
		for (const error of errors) {
			console.error("- ", error);
		}
		if (process.env.DRAFT !== "true") {
			process.exit(1);
		} else {
			console.error("These errors must be fixed before you can merge this PR.");
			console.error(
				"When you mark this PR as ready for review the CI check will start failing."
			);
		}
	}
}

export function validateDescription(
	title: string,
	body: string,
	labels: string,
	changedFilesJson: string
) {
	const errors: string[] = [];

	console.log("PR:", title);

	const parsedLabels = JSON.parse(labels) as string[];

	if (parsedLabels.includes("ci:skip-pr-description-validation")) {
		console.log(
			"Skipping validation because the `ci:skip-pr-description-validation` label has been applied"
		);
		return [];
	}

	if (
		!(
			/- \[x\] Tests included\/updated/i.test(body) ||
			/- \[x\] Automated tests not possible - manual testing has been completed as follows:\s*.+/i.test(
				body
			) ||
			/- \[x\] Additional testing not necessary because:\s*.+/i.test(body)
		)
	) {
		errors.push(
			"Your PR must include tests, or provide justification for why no tests are required in the PR description and apply the `ci:no-tests` label"
		);
	}

	const changedFiles = JSON.parse(changedFilesJson) as string[];
	const changesetIncluded = changedFiles.some((f) =>
		f.startsWith(".changeset/")
	);

	if (
		!changesetIncluded &&
		!parsedLabels.includes("ci:no-changeset-required")
	) {
		errors.push(
			"Your PR doesn't include a changeset. Either include one (following the instructions in CONTRIBUTING.md) or add the 'ci:no-changeset-required' label to bypass this check. Most PRs should have a changeset, so only bypass this check if you're sure that your change doesn't need one: see https://github.com/cloudflare/workers-sdk/blob/main/CONTRIBUTING.md#changesets for more details."
		);
	}

	if (
		!(
			/- \[x\] Cloudflare docs PR\(s\): https:\/\/(github\.com\/cloudflare\/cloudflare-docs\/(pull|issues)\/\d+|developers\.cloudflare\.com\/.*)/i.test(
				body
			) || /- \[x\] Documentation not necessary because: .+/i.test(body)
		)
	) {
		errors.push(
			"Your PR must include documentation (in the form of a link to a Cloudflare Docs issue or PR), or provide justification for why no documentation is required"
		);
	}

	return errors;
}