ci: validate form

Author: sxyazi

.github/workflows/validate-form.yml

@@ -0,0 +1,34 @@
+name: Validate Form
+
+on:
+  issues:
+    types: [opened, edited]
+  schedule:
+    - cron: "20 * * * *"
+
+jobs:
+  check-version:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-js: 20
+
+      - name: Install Dependencies
+        run: |
+          cd scripts/validate-form
+          npm ci
+
+      - name: Validate Form
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const script = require('./scripts/validate-form/main.js')
+            await script({github, context, core})
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,5 +1,6 @@
 target/
 yazi-*/completions
+node_modules/
 
 .DS_Store
 

scripts/validate-form/main.js

@@ -0,0 +1,146 @@
+const LABEL_NAME = "needs info"
+const RE_CHECKLIST = /#{3}\s+Checklist\s+(?:^-\s+\[x]\s+.+?\n){2}/gm
+
+function bugReportBody(creator, content, hash) {
+	if (content.includes(` (${hash} `) && RE_CHECKLIST.test(content)) {
+		return null
+	}
+
+	return `Hey @${creator}, I noticed that you did not correctly follow the bug report template. Please ensure that:
+
+- The bug can still be reproduced on the [newest nightly build](https://yazi-rs.github.io/docs/installation/#binaries).
+- The debug information (\`yazi --debug\`) is updated for the newest nightly.
+- All required fields in the checklist have been checked.
+
+Issues marked with \`${LABEL_NAME}\` will be closed if they have no activity within 2 days.
+`
+}
+
+function featureRequestBody(creator, content, hash) {
+	if (content.includes(` (${hash} `) && RE_CHECKLIST.test(content)) {
+		return null
+	}
+
+	return `Hey @${creator}, I noticed that you did not correctly follow the feature request template. Please ensure that:
+
+- The requested feature does not exist in the [newest nightly build](https://yazi-rs.github.io/docs/installation/#binaries).
+- The debug information (\`yazi --debug\`) is updated for the newest nightly.
+- All required fields in the checklist have been checked.
+
+Issues marked with \`${LABEL_NAME}\` will be closed if they have no activity within 2 days.
+`
+}
+
+module.exports = async ({ github, context, core }) => {
+	async function nightlyHash() {
+		try {
+			const { data: tagRef } = await github.rest.git.getRef({ owner: "sxyazi", repo: "yazi", ref: "tags/nightly" })
+			return tagRef.object.sha.slice(0, 7)
+		} catch (e) {
+			if (e.status === 404) {
+				core.error("Nightly tag not found")
+			} else {
+				core.error(`Error fetching nightly version: ${e.message}`)
+			}
+			return null
+		}
+	}
+
+	async function hasLabel(id, label) {
+		try {
+			const { data: labels } = await github.rest.issues.listLabelsOnIssue({
+				...context.repo,
+				issue_number: id,
+			})
+			return labels.some(l => l.name === label)
+		} catch (e) {
+			core.error(`Error checking labels: ${e.message}`)
+			return false
+		}
+	}
+
+	async function updateLabels(id, mark, body) {
+		try {
+			const marked = await hasLabel(id, LABEL_NAME)
+			if (mark && !marked) {
+				await github.rest.issues.addLabels({
+					...context.repo,
+					issue_number: id,
+					labels: [LABEL_NAME],
+				})
+				await github.rest.issues.createComment({
+					...context.repo,
+					issue_number: id,
+					body,
+				})
+			} else if (!mark && marked) {
+				await github.rest.issues.removeLabel({
+					...context.repo,
+					issue_number: id,
+					name: LABEL_NAME,
+				})
+			}
+		} catch (e) {
+			core.error(`Error updating labels: ${e.message}`)
+		}
+	}
+
+	async function closeOldIssues() {
+		try {
+			const { data: issues } = await github.rest.issues.listForRepo({
+				...context.repo,
+				state: "open",
+				labels: LABEL_NAME,
+			})
+
+			const now = new Date()
+			const twoDaysAgo = new Date(now - 2 * 24 * 60 * 60 * 1000)
+
+			for (const issue of issues) {
+				const markedAt = new Date(issue.labels_at || issue.created_at)
+				if (markedAt < twoDaysAgo) {
+					await github.rest.issues.update({
+						...context.repo,
+						issue_number: issue.number,
+						state: "closed",
+						state_reason: "not_planned",
+					})
+					await github.rest.issues.createComment({
+						...context.repo,
+						issue_number: issue.number,
+						body: `This issue has been automatically closed because it was marked as \`${LABEL_NAME}\` for more than 2 days without updates.
+If the problem persists, please file a new issue and complete the issue template so we can capture all the details necessary to investigate further.`,
+					})
+				}
+			}
+		} catch (e) {
+			core.error(`Error checking old issues: ${e.message}`)
+		}
+	}
+
+	async function main() {
+		const hash = await nightlyHash()
+		if (!hash) return
+
+		if (context.eventName === "schedule") {
+			await closeOldIssues()
+			return
+		}
+
+		if (context.eventName === "issues") {
+			const id = context.payload.issue.number
+			const content = context.payload.issue.body || ""
+			const creator = context.payload.issue.user.login
+
+			if (await hasLabel(id, "bug")) {
+				const body = bugReportBody(creator, content, hash)
+				await updateLabels(id, !!body, body)
+			} else if (await hasLabel(id, "feature")) {
+				const body = featureRequestBody(creator, content, hash)
+				await updateLabels(id, !!body, body)
+			}
+		}
+	}
+
+	await main()
+}