mirror of
https://github.com/streamyfin/streamyfin.git
synced 2026-06-02 12:08:37 +01:00
Compare commits
3 Commits
fix/misali
...
ci/pr-vali
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
935cacff81 | ||
|
|
5f59dce0c7 | ||
|
|
3de9b65b7d |
32
.github/workflows/linting.yml
vendored
32
.github/workflows/linting.yml
vendored
@@ -12,38 +12,6 @@ permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
validate_pr_title:
|
||||
name: "📝 Validate PR Title"
|
||||
if: github.event_name == 'pull_request'
|
||||
runs-on: ubuntu-24.04
|
||||
permissions:
|
||||
pull-requests: write
|
||||
contents: read
|
||||
steps:
|
||||
- uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1
|
||||
id: lint_pr_title
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- uses: marocchino/sticky-pull-request-comment@0ea0beb66eb9baf113663a64ec522f60e49231c0 # v3.0.4
|
||||
if: always() && (steps.lint_pr_title.outputs.error_message != null)
|
||||
with:
|
||||
header: pr-title-lint-error
|
||||
message: |
|
||||
Hey there and thank you for opening this pull request! 👋🏼
|
||||
We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
|
||||
|
||||
**Error details:**
|
||||
```
|
||||
${{ steps.lint_pr_title.outputs.error_message }}
|
||||
```
|
||||
|
||||
- if: ${{ steps.lint_pr_title.outputs.error_message == null }}
|
||||
uses: marocchino/sticky-pull-request-comment@0ea0beb66eb9baf113663a64ec522f60e49231c0 # v3.0.4
|
||||
with:
|
||||
header: pr-title-lint-error
|
||||
delete: true
|
||||
|
||||
dependency-review:
|
||||
name: 🔍 Vulnerable Dependencies
|
||||
runs-on: ubuntu-24.04
|
||||
|
||||
136
.github/workflows/pr-validation.yml
vendored
Normal file
136
.github/workflows/pr-validation.yml
vendored
Normal file
@@ -0,0 +1,136 @@
|
||||
name: 🚦 PR Validation
|
||||
|
||||
# Uses pull_request_target so the jobs get a write token even on fork PRs (to comment
|
||||
# and label) — same as seerr. SECURITY: never check out or run the PR head's code here;
|
||||
# we only read the title/body from the event payload and run our own scripts from the base.
|
||||
on:
|
||||
pull_request_target:
|
||||
types: [opened, edited, synchronize, reopened]
|
||||
workflow_dispatch:
|
||||
|
||||
permissions: {}
|
||||
|
||||
concurrency:
|
||||
group: pr-validation-${{ github.event.pull_request.number || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
validate_pr_title:
|
||||
name: "📝 Validate PR Title"
|
||||
if: github.event_name == 'pull_request_target'
|
||||
runs-on: ubuntu-24.04
|
||||
permissions:
|
||||
pull-requests: write
|
||||
contents: read
|
||||
steps:
|
||||
- uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1
|
||||
id: lint_pr_title
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- uses: marocchino/sticky-pull-request-comment@0ea0beb66eb9baf113663a64ec522f60e49231c0 # v3.0.4
|
||||
if: always() && (steps.lint_pr_title.outputs.error_message != null)
|
||||
with:
|
||||
header: pr-title-lint-error
|
||||
message: |
|
||||
Hey there and thank you for opening this pull request! 👋🏼
|
||||
We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
|
||||
|
||||
**Error details:**
|
||||
```
|
||||
${{ steps.lint_pr_title.outputs.error_message }}
|
||||
```
|
||||
|
||||
- if: ${{ steps.lint_pr_title.outputs.error_message == null }}
|
||||
uses: marocchino/sticky-pull-request-comment@0ea0beb66eb9baf113663a64ec522f60e49231c0 # v3.0.4
|
||||
with:
|
||||
header: pr-title-lint-error
|
||||
delete: true
|
||||
|
||||
validate_pr_template:
|
||||
name: "📋 Validate PR Template"
|
||||
# Skip pushes to an existing PR (the body rarely changes) and bot-authored PRs.
|
||||
if: >-
|
||||
github.event_name == 'pull_request_target' &&
|
||||
github.event.action != 'synchronize' &&
|
||||
github.actor != 'renovate[bot]' &&
|
||||
github.actor != 'github-actions[bot]'
|
||||
runs-on: ubuntu-24.04
|
||||
permissions:
|
||||
pull-requests: write
|
||||
issues: write
|
||||
contents: read
|
||||
steps:
|
||||
- name: "📥 Checkout"
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
|
||||
- name: "🍞 Setup Bun"
|
||||
uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2.2.0
|
||||
with:
|
||||
bun-version: latest
|
||||
|
||||
- name: "📝 Write PR body to file"
|
||||
env:
|
||||
PR_BODY: ${{ github.event.pull_request.body }}
|
||||
run: printf '%s' "$PR_BODY" > /tmp/pr-body.txt
|
||||
|
||||
- name: "📂 List changed files"
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: |
|
||||
gh api "repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/files" \
|
||||
--paginate --jq '.[].filename' > /tmp/pr-files.txt
|
||||
|
||||
- name: "🔎 Validate body against template"
|
||||
id: check
|
||||
env:
|
||||
AUTHOR_ASSOCIATION: ${{ github.event.pull_request.author_association }}
|
||||
PR_FILES: /tmp/pr-files.txt
|
||||
run: |
|
||||
set +e
|
||||
bun scripts/check-pr-template.mjs /tmp/pr-body.txt > /tmp/pr-issues.json
|
||||
echo "code=$?" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: "💬 Report problems"
|
||||
if: steps.check.outputs.code != '0'
|
||||
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v8.0.0
|
||||
with:
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
let issues;
|
||||
try { issues = JSON.parse(fs.readFileSync('/tmp/pr-issues.json', 'utf8')); }
|
||||
catch { issues = ["The PR template check could not parse the description. Please make sure it follows the template."]; }
|
||||
if (!Array.isArray(issues) || issues.length === 0) issues = ["The PR description does not follow the template."];
|
||||
const body = [
|
||||
"👋 Thanks for the PR! A few things in the description need attention before review:",
|
||||
"",
|
||||
...issues.map((i) => `- ${i}`),
|
||||
"",
|
||||
"Please update the PR description ([template](https://github.com/${{ github.repository }}/blob/develop/.github/pull_request_template.md)). This check re-runs when you edit it.",
|
||||
].join("\n");
|
||||
const { owner, repo } = context.repo;
|
||||
const issue_number = context.payload.pull_request.number;
|
||||
const marker = "<!-- pr-template-check -->";
|
||||
const comments = await github.paginate(github.rest.issues.listComments, { owner, repo, issue_number });
|
||||
const existing = comments.find((c) => c.body?.includes(marker));
|
||||
const payload = `${marker}\n${body}`;
|
||||
if (existing) await github.rest.issues.updateComment({ owner, repo, comment_id: existing.id, body: payload });
|
||||
else await github.rest.issues.createComment({ owner, repo, issue_number, body: payload });
|
||||
const label = "blocked: template";
|
||||
try { await github.rest.issues.getLabel({ owner, repo, name: label }); }
|
||||
catch { await github.rest.issues.createLabel({ owner, repo, name: label, color: "d93f0b", description: "PR description does not follow the template" }); }
|
||||
await github.rest.issues.addLabels({ owner, repo, issue_number, labels: [label] });
|
||||
core.setFailed(`PR template check failed:\n- ${issues.join("\n- ")}`);
|
||||
|
||||
- name: "✅ Clear problems on success"
|
||||
if: steps.check.outputs.code == '0'
|
||||
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v8.0.0
|
||||
with:
|
||||
script: |
|
||||
const { owner, repo } = context.repo;
|
||||
const issue_number = context.payload.pull_request.number;
|
||||
const marker = "<!-- pr-template-check -->";
|
||||
const comments = await github.paginate(github.rest.issues.listComments, { owner, repo, issue_number });
|
||||
const existing = comments.find((c) => c.body?.includes(marker));
|
||||
if (existing) await github.rest.issues.deleteComment({ owner, repo, comment_id: existing.id });
|
||||
try { await github.rest.issues.removeLabel({ owner, repo, issue_number, name: "blocked: template" }); } catch {}
|
||||
@@ -166,7 +166,7 @@ export default function IndexLayout() {
|
||||
open={dropdownOpen}
|
||||
onOpenChange={setDropdownOpen}
|
||||
trigger={
|
||||
<View>
|
||||
<View className='pl-1.5'>
|
||||
<Ionicons
|
||||
name='ellipsis-horizontal-outline'
|
||||
size={24}
|
||||
|
||||
@@ -1,7 +1,13 @@
|
||||
import { Ionicons } from "@expo/vector-icons";
|
||||
import { BottomSheetScrollView } from "@gorhom/bottom-sheet";
|
||||
import React, { useEffect } from "react";
|
||||
import { Platform, StyleSheet, TouchableOpacity, View } from "react-native";
|
||||
import React, { useEffect, useState } from "react";
|
||||
import {
|
||||
type LayoutChangeEvent,
|
||||
Platform,
|
||||
StyleSheet,
|
||||
TouchableOpacity,
|
||||
View,
|
||||
} from "react-native";
|
||||
import { useSafeAreaInsets } from "react-native-safe-area-context";
|
||||
import { Text } from "@/components/common/Text";
|
||||
import { useGlobalModal } from "@/providers/GlobalModalProvider";
|
||||
@@ -211,6 +217,24 @@ const PlatformDropdownComponent = ({
|
||||
}: PlatformDropdownProps) => {
|
||||
const { showModal, hideModal, isVisible } = useGlobalModal();
|
||||
|
||||
// @expo/ui's <Host> (SDK 55) fills its available space by default, and
|
||||
// `matchContents` doesn't help here: it reports the native Menu's size via
|
||||
// setStyleSize and overrides any explicit size. Instead we measure the
|
||||
// trigger's intrinsic size in plain RN (off-layout) and pin it on the Host.
|
||||
const [triggerSize, setTriggerSize] = useState<{
|
||||
width: number;
|
||||
height: number;
|
||||
} | null>(null);
|
||||
|
||||
const handleMeasureTrigger = (e: LayoutChangeEvent) => {
|
||||
const { width, height } = e.nativeEvent.layout;
|
||||
setTriggerSize((prev) =>
|
||||
prev && prev.width === width && prev.height === height
|
||||
? prev
|
||||
: { width, height },
|
||||
);
|
||||
};
|
||||
|
||||
// Handle controlled open state for Android
|
||||
useEffect(() => {
|
||||
if (Platform.OS === "android" && controlledOpen === true) {
|
||||
@@ -241,11 +265,25 @@ const PlatformDropdownComponent = ({
|
||||
}, [isVisible, controlledOpen, controlledOnOpenChange]);
|
||||
|
||||
if (Platform.OS === "ios" && !Platform.isTV) {
|
||||
// @expo/ui's <Host> can't size to content, so an in-flow invisible copy of
|
||||
// the trigger sizes the wrapper while the Host overlays the real Menu.
|
||||
// Pin the wrapper to the measured trigger size. @expo/ui's <Host> (SDK 55)
|
||||
// fills its parent and reports its own size via setStyleSize, so it can't
|
||||
// size itself to content. If the wrapper has no size, the Host's `flex: 1`
|
||||
// height depends on the parent while the parent depends on the Host — a
|
||||
// circular dependency that collapses to 0 for any selector nested more than
|
||||
// one level deep (so only the first, shallowest dropdown stays visible).
|
||||
// Giving the wrapper the measured size breaks the cycle; the Host then
|
||||
// fills a concrete box.
|
||||
return (
|
||||
<View>
|
||||
<View pointerEvents='none' aria-hidden style={{ opacity: 0 }}>
|
||||
<View style={triggerSize ?? { opacity: 0 }}>
|
||||
{/* Hidden measurer: lays the trigger out off-flow to capture its
|
||||
intrinsic size. Absolutely positioned WITHOUT right/bottom so it
|
||||
sizes to the trigger's content rather than to its parent. */}
|
||||
<View
|
||||
style={{ position: "absolute", top: 0, left: 0, opacity: 0 }}
|
||||
pointerEvents='none'
|
||||
aria-hidden
|
||||
onLayout={handleMeasureTrigger}
|
||||
>
|
||||
{trigger}
|
||||
</View>
|
||||
<Host style={[StyleSheet.absoluteFill, expoUIConfig?.hostStyle as any]}>
|
||||
|
||||
@@ -133,6 +133,7 @@ const HomeMobile = () => {
|
||||
onPress={() => {
|
||||
router.push("/(auth)/downloads");
|
||||
}}
|
||||
className='ml-1.5'
|
||||
style={{ marginRight: Platform.OS === "android" ? 16 : 0 }}
|
||||
>
|
||||
<Feather
|
||||
|
||||
@@ -401,6 +401,10 @@ export const TVJellyseerrSearchResults: React.FC<
|
||||
}) => {
|
||||
const { t } = useTranslation();
|
||||
|
||||
const hasMovies = movieResults && movieResults.length > 0;
|
||||
const hasTv = tvResults && tvResults.length > 0;
|
||||
const hasPersons = personResults && personResults.length > 0;
|
||||
|
||||
if (loading) {
|
||||
return null;
|
||||
}
|
||||
@@ -427,26 +431,22 @@ export const TVJellyseerrSearchResults: React.FC<
|
||||
|
||||
return (
|
||||
<View>
|
||||
{/* No section requests `hasTVPreferredFocus`: the native search field
|
||||
keeps focus while typing, otherwise the first result would re-grab
|
||||
focus on every keystroke as results re-render. The user navigates
|
||||
down to the grid manually. */}
|
||||
<TVJellyseerrMovieSection
|
||||
title={t("search.request_movies")}
|
||||
items={movieResults}
|
||||
isFirstSection={false}
|
||||
isFirstSection={hasMovies}
|
||||
onItemPress={onMoviePress}
|
||||
/>
|
||||
<TVJellyseerrTvSection
|
||||
title={t("search.request_series")}
|
||||
items={tvResults}
|
||||
isFirstSection={false}
|
||||
isFirstSection={!hasMovies && hasTv}
|
||||
onItemPress={onTvPress}
|
||||
/>
|
||||
<TVJellyseerrPersonSection
|
||||
title={t("search.actors")}
|
||||
items={personResults}
|
||||
isFirstSection={false}
|
||||
isFirstSection={!hasMovies && !hasTv && hasPersons}
|
||||
onItemPress={onPersonPress}
|
||||
/>
|
||||
</View>
|
||||
|
||||
@@ -235,13 +235,10 @@ export const TVSearchPage: React.FC<TVSearchPageProps> = ({
|
||||
module). It renders the native search bar + grid keyboard and
|
||||
forwards typed text into the existing query pipeline via setSearch;
|
||||
our own results grid renders below. */}
|
||||
{/* No horizontal margin here: the native tvOS search bar centers itself
|
||||
and renders a trailing "Hold to Dictate in <Language>" hint. Extra
|
||||
margins squeeze the bar's width and clip that trailing hint, so let
|
||||
the native view span the full width and own its own insets. */}
|
||||
<View
|
||||
style={{
|
||||
marginBottom: 24,
|
||||
marginHorizontal: HORIZONTAL_PADDING,
|
||||
height: SEARCH_AREA_HEIGHT,
|
||||
}}
|
||||
>
|
||||
@@ -283,17 +280,13 @@ export const TVSearchPage: React.FC<TVSearchPageProps> = ({
|
||||
{/* Library Search Results */}
|
||||
{isLibraryMode && !loading && (
|
||||
<View style={{ gap: SECTION_GAP }}>
|
||||
{sections.map((section) => (
|
||||
{sections.map((section, index) => (
|
||||
<TVSearchSection
|
||||
key={section.key}
|
||||
title={section.title}
|
||||
items={section.items!}
|
||||
orientation={section.orientation || "vertical"}
|
||||
// Never auto-focus a result. The native search field owns focus
|
||||
// while typing; `hasTVPreferredFocus` here would re-grab focus on
|
||||
// every keystroke as results re-render. User navigates down to the
|
||||
// grid manually.
|
||||
isFirstSection={false}
|
||||
isFirstSection={index === 0}
|
||||
onItemPress={onItemPress}
|
||||
onItemLongPress={onItemLongPress}
|
||||
imageUrlGetter={
|
||||
|
||||
@@ -297,12 +297,12 @@ export const TVSearchSection: React.FC<TVSearchSectionProps> = ({
|
||||
removeClippedSubviews={false}
|
||||
getItemLayout={getItemLayout}
|
||||
style={{ overflow: "visible" }}
|
||||
// Edge padding via contentContainerStyle, NOT contentInset+contentOffset.
|
||||
// contentOffset only applies on initial mount; since this FlatList is
|
||||
// reused across searches (stable key), a second search left the inset
|
||||
// without the offset and the grid snapped flush to the left edge.
|
||||
contentInset={{
|
||||
left: edgePadding,
|
||||
right: edgePadding,
|
||||
}}
|
||||
contentOffset={{ x: -edgePadding, y: 0 }}
|
||||
contentContainerStyle={{
|
||||
paddingHorizontal: edgePadding,
|
||||
paddingVertical: SCALE_PADDING,
|
||||
}}
|
||||
/>
|
||||
|
||||
@@ -1254,7 +1254,7 @@ export const Controls: FC<Props> = ({
|
||||
<Text
|
||||
style={[styles.endsAtText, { fontSize: typography.callout }]}
|
||||
>
|
||||
{t("player.ends_at", { time: getFinishTime() })}
|
||||
{t("player.ends_at")} {getFinishTime()}
|
||||
</Text>
|
||||
</View>
|
||||
)}
|
||||
@@ -1448,7 +1448,7 @@ export const Controls: FC<Props> = ({
|
||||
<Text
|
||||
style={[styles.endsAtText, { fontSize: typography.callout }]}
|
||||
>
|
||||
{t("player.ends_at", { time: getFinishTime() })}
|
||||
{t("player.ends_at")} {getFinishTime()}
|
||||
</Text>
|
||||
</View>
|
||||
)}
|
||||
|
||||
@@ -81,6 +81,7 @@ class MpvPlayerView: ExpoView {
|
||||
private func setupView() {
|
||||
clipsToBounds = true
|
||||
backgroundColor = .black
|
||||
configureAudioSession()
|
||||
|
||||
videoContainer = UIView()
|
||||
videoContainer.translatesAutoresizingMaskIntoConstraints = false
|
||||
@@ -140,26 +141,21 @@ class MpvPlayerView: ExpoView {
|
||||
CATransaction.commit()
|
||||
}
|
||||
|
||||
// MARK: - Audio Session & Notifications
|
||||
|
||||
private func configureAudioSession() {
|
||||
let session = AVAudioSession.sharedInstance()
|
||||
let audioSession = AVAudioSession.sharedInstance()
|
||||
do {
|
||||
try session.setCategory(.playback, mode: .moviePlayback, policy: .longFormAudio, options: [])
|
||||
try session.setActive(true)
|
||||
try audioSession.setCategory(
|
||||
.playback,
|
||||
mode: .moviePlayback,
|
||||
policy: .longFormAudio,
|
||||
options: []
|
||||
)
|
||||
try audioSession.setActive(true)
|
||||
} catch {
|
||||
print("Failed to configure audio session: \(error)")
|
||||
}
|
||||
}
|
||||
|
||||
/// Deactivate the session AND reset the category — `setActive(false)` alone
|
||||
/// leaves `.playback`/`.longFormAudio` on the shared singleton, so any later
|
||||
/// reactivation (foreground, route change, other modules) re-steals audio.
|
||||
private func tearDownAudioSession() {
|
||||
let session = AVAudioSession.sharedInstance()
|
||||
try? session.setActive(false, options: .notifyOthersOnDeactivation)
|
||||
try? session.setCategory(.ambient, mode: .default, options: [.mixWithOthers])
|
||||
}
|
||||
// MARK: - Audio Session & Notifications
|
||||
|
||||
private func setupNotifications() {
|
||||
// Handle audio session interruptions (e.g., incoming calls, other apps playing audio)
|
||||
@@ -274,7 +270,6 @@ class MpvPlayerView: ExpoView {
|
||||
|
||||
func play() {
|
||||
intendedPlayState = true
|
||||
configureAudioSession()
|
||||
setupRemoteCommands()
|
||||
renderer?.play()
|
||||
pipController?.setPlaybackRate(1.0)
|
||||
@@ -445,7 +440,6 @@ class MpvPlayerView: ExpoView {
|
||||
renderer?.stop()
|
||||
displayLayer.removeFromSuperlayer()
|
||||
clearNowPlayingInfo()
|
||||
tearDownAudioSession()
|
||||
NotificationCenter.default.removeObserver(self)
|
||||
}
|
||||
}
|
||||
@@ -525,7 +519,9 @@ extension MpvPlayerView: MPVLayerRendererDelegate {
|
||||
}
|
||||
|
||||
func renderer(_: MPVLayerRenderer, didSelectAudioOutput audioOutput: String) {
|
||||
print("[MPV] Audio output ready (\(audioOutput)), syncing Now Playing")
|
||||
// Audio output is now active - this is the right time to activate audio session and set Now Playing
|
||||
print("[MPV] Audio output ready (\(audioOutput)), activating audio session and syncing Now Playing")
|
||||
nowPlayingManager.activateAudioSession()
|
||||
syncNowPlaying(isPlaying: !isPaused())
|
||||
}
|
||||
}
|
||||
|
||||
119
scripts/check-pr-template.mjs
Normal file
119
scripts/check-pr-template.mjs
Normal file
@@ -0,0 +1,119 @@
|
||||
#!/usr/bin/env bun
|
||||
/**
|
||||
* Validates that a pull request body follows .github/pull_request_template.md:
|
||||
* required sections are filled in and the key checklist items are ticked.
|
||||
*
|
||||
* Usage: bun scripts/check-pr-template.mjs <path-to-pr-body.txt>
|
||||
* Output: a JSON array of human-readable problems (empty array = all good).
|
||||
* Exit: 0 = ok, 1 = one or more problems, 2 = no body file given.
|
||||
*
|
||||
* Env: AUTHOR_ASSOCIATION — when OWNER/MEMBER/COLLABORATOR, the AI-disclosure
|
||||
* check is skipped (maintainers self-police).
|
||||
*/
|
||||
|
||||
import { existsSync, readFileSync } from "node:fs";
|
||||
|
||||
const bodyFile = process.argv[2];
|
||||
if (!bodyFile) {
|
||||
console.error("usage: bun scripts/check-pr-template.mjs <pr-body-file>");
|
||||
process.exit(2);
|
||||
}
|
||||
|
||||
let body;
|
||||
try {
|
||||
body = readFileSync(bodyFile, "utf8").replace(/\r\n/g, "\n");
|
||||
} catch (e) {
|
||||
console.error(`cannot read body file ${bodyFile}: ${e.message}`);
|
||||
process.exit(2);
|
||||
}
|
||||
const association = (process.env.AUTHOR_ASSOCIATION || "").toUpperCase();
|
||||
const isMaintainer = ["OWNER", "MEMBER", "COLLABORATOR"].includes(association);
|
||||
|
||||
// Strip HTML comments in a single linear pass: remove complete `<!-- … -->`
|
||||
// blocks, then drop any leftover unterminated `<!-- …` to end-of-string. This
|
||||
// leaves no `<!--` behind (satisfies CodeQL) without the quadratic re-scan loop
|
||||
// a malicious deeply-nested body could abuse for CPU-DoS.
|
||||
const stripComments = (s) =>
|
||||
s
|
||||
.replace(/<!--[\s\S]*?-->/g, "")
|
||||
.replace(/<!--[\s\S]*$/, "")
|
||||
.trim();
|
||||
|
||||
// Grab the text under a heading whose title contains `keyword`, up to the next heading
|
||||
// or the end of the body.
|
||||
const section = (keyword) => {
|
||||
const re = new RegExp(
|
||||
`(?:^|\\n)#{1,4}\\s*[^\\n]*${keyword}[^\\n]*\\n([\\s\\S]*?)(?=\\n#{1,4}\\s|$)`,
|
||||
"i",
|
||||
);
|
||||
const m = body.match(re);
|
||||
return m ? m[1] : null;
|
||||
};
|
||||
|
||||
const isFilled = (content) => {
|
||||
if (content == null) return false;
|
||||
// Template guidance lives in HTML comments; once stripped, a real answer remains.
|
||||
return stripComments(content).length > 0;
|
||||
};
|
||||
|
||||
const issues = [];
|
||||
|
||||
if (section("Description") === null)
|
||||
issues.push("The **Description** section is missing.");
|
||||
else if (!isFilled(section("Description")))
|
||||
issues.push(
|
||||
"The **Description** section is empty — describe what changed and why.",
|
||||
);
|
||||
|
||||
if (section("Ticket") === null)
|
||||
issues.push("The **Ticket / Issue** section is missing.");
|
||||
else if (!isFilled(section("Ticket")))
|
||||
issues.push(
|
||||
"The **Ticket / Issue** section is empty — link an issue or write `N/A`.",
|
||||
);
|
||||
|
||||
if (section("Testing Instructions") === null)
|
||||
issues.push("The **Testing Instructions** section is missing.");
|
||||
else if (!isFilled(section("Testing Instructions")))
|
||||
issues.push(
|
||||
"The **Testing Instructions** section is empty — tell reviewers how to test this, or write `N/A`.",
|
||||
);
|
||||
|
||||
const checklist = section("Checklist");
|
||||
if (checklist === null) {
|
||||
issues.push("The **Checklist** section is missing.");
|
||||
} else {
|
||||
if (!/- \[x\][^\n]*contribution guidelines/i.test(checklist))
|
||||
issues.push(
|
||||
"Please read and tick the **contribution guidelines** checklist item.",
|
||||
);
|
||||
if (!isMaintainer && !/- \[x\][^\n]*declared if AI/i.test(checklist))
|
||||
issues.push(
|
||||
"Please tick the **AI disclosure** checklist item (declare whether AI was used).",
|
||||
);
|
||||
}
|
||||
|
||||
// Require the Screenshots section when the PR changes UI (.tsx under app/ or components/).
|
||||
// PR_FILES points to a newline list of changed paths (provided by the workflow).
|
||||
const filesPath = process.env.PR_FILES;
|
||||
if (filesPath && existsSync(filesPath)) {
|
||||
const changed = readFileSync(filesPath, "utf8").split("\n").filter(Boolean);
|
||||
const touchesUI = changed.some(
|
||||
(f) =>
|
||||
/^(app|components)\/.*\.tsx$/.test(f) && !/\.(test|spec)\.tsx$/.test(f),
|
||||
);
|
||||
if (touchesUI) {
|
||||
const shots = section("Screenshots");
|
||||
if (shots === null)
|
||||
issues.push(
|
||||
"This PR changes UI (`.tsx`) — add the **Screenshots / GIFs** section with before/after media.",
|
||||
);
|
||||
else if (!isFilled(shots))
|
||||
issues.push(
|
||||
"This PR changes UI — the **Screenshots / GIFs** section is empty; add screenshots (or write `N/A` if it's genuinely not visual).",
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
console.log(JSON.stringify(issues));
|
||||
process.exit(issues.length ? 1 : 0);
|
||||
Reference in New Issue
Block a user