mirror of
https://github.com/community-scripts/ProxmoxVE.git
synced 2026-07-16 19:05:07 +02:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e15db754a6 |
+163
@@ -0,0 +1,163 @@
|
|||||||
|
name: Close PRs Missing Template
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
branches: ["main"]
|
||||||
|
types: [opened, edited, reopened, synchronize, labeled]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
validate-pr-template:
|
||||||
|
if: github.repository == 'community-scripts/ProxmoxVE'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
pull-requests: write
|
||||||
|
issues: write
|
||||||
|
contents: read
|
||||||
|
steps:
|
||||||
|
- name: Close PR if it does not follow the PR template
|
||||||
|
uses: actions/github-script@v7
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const pr = context.payload.pull_request;
|
||||||
|
const prNumber = pr.number;
|
||||||
|
const author = pr.user.login;
|
||||||
|
const owner = context.repo.owner;
|
||||||
|
const repo = context.repo.repo;
|
||||||
|
|
||||||
|
const allowedBots = [
|
||||||
|
"push-app-to-main[bot]",
|
||||||
|
"push-app-to-main",
|
||||||
|
"community-scripts-pr-app",
|
||||||
|
"github-actions[bot]",
|
||||||
|
"dependabot[bot]",
|
||||||
|
];
|
||||||
|
|
||||||
|
if (allowedBots.includes(author) || author.endsWith("[bot]")) {
|
||||||
|
core.info(`PR #${prNumber} by bot "${author}" — skipping template validation.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const association = pr.author_association;
|
||||||
|
const exemptAssociations = ["OWNER", "MEMBER", "COLLABORATOR"];
|
||||||
|
if (exemptAssociations.includes(association)) {
|
||||||
|
core.info(`PR #${prNumber} by ${association} "${author}" — skipping template validation.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const labels = pr.labels.map((label) => label.name);
|
||||||
|
const skipLabels = ["automated pr", "keep open"];
|
||||||
|
|
||||||
|
if (skipLabels.some((label) => labels.includes(label))) {
|
||||||
|
core.info(`PR #${prNumber} has a skip label (${labels.join(", ")}) — skipping template validation.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (pr.draft) {
|
||||||
|
core.info(`PR #${prNumber} is a draft — skipping template validation.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const body = pr.body || "";
|
||||||
|
const failures = [];
|
||||||
|
|
||||||
|
const requiredSections = [
|
||||||
|
"## ✍️ Description",
|
||||||
|
"## ✅ Prerequisites",
|
||||||
|
"## 🛠️ Type of Change",
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const section of requiredSections) {
|
||||||
|
if (!body.includes(section)) {
|
||||||
|
failures.push(`Missing required section: \`${section}\``);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const descriptionMatch = body.match(
|
||||||
|
/## ✍️ Description\s*\n+([\s\S]*?)(?=\n## )/i
|
||||||
|
);
|
||||||
|
const description = (descriptionMatch?.[1] || "").trim();
|
||||||
|
if (!description) {
|
||||||
|
failures.push("The **Description** section is empty.");
|
||||||
|
}
|
||||||
|
|
||||||
|
const prerequisiteCheckboxes = [
|
||||||
|
"**Self-review completed**",
|
||||||
|
"**Tested thoroughly**",
|
||||||
|
"**No security risks**",
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const checkbox of prerequisiteCheckboxes) {
|
||||||
|
const escaped = checkbox.replace(/([.*+?^=!:${}()|[\]\/\\])/g, "\\$1");
|
||||||
|
const regex = new RegExp(`- \\[(x|X)\\]\\s*${escaped}`, "i");
|
||||||
|
if (!regex.test(body)) {
|
||||||
|
failures.push(`Prerequisite not checked: ${checkbox}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const typeOfChangeCheckboxes = [
|
||||||
|
"🐞 **Bug fix**",
|
||||||
|
"✨ **New feature**",
|
||||||
|
"💥 **Breaking change**",
|
||||||
|
"🆕 **New script**",
|
||||||
|
"🌍 **Website update**",
|
||||||
|
"🔧 **Refactoring / Code Cleanup**",
|
||||||
|
"📝 **Documentation update**",
|
||||||
|
];
|
||||||
|
|
||||||
|
const hasTypeChecked = typeOfChangeCheckboxes.some((checkbox) => {
|
||||||
|
const escaped = checkbox.replace(/([.*+?^=!:${}()|[\]\/\\])/g, "\\$1");
|
||||||
|
const regex = new RegExp(`- \\[(x|X)\\]\\s*${escaped}`, "i");
|
||||||
|
return regex.test(body);
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!hasTypeChecked) {
|
||||||
|
failures.push("At least one **Type of Change** checkbox must be checked.");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (failures.length === 0) {
|
||||||
|
core.info(`PR #${prNumber} follows the PR template.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
core.info(`Closing PR #${prNumber} — template validation failed.`);
|
||||||
|
|
||||||
|
const templateUrl =
|
||||||
|
"https://github.com/community-scripts/ProxmoxVE/blob/main/.github/pull_request_template.md";
|
||||||
|
const failureList = failures.map((item) => `- ${item}`).join("\n");
|
||||||
|
|
||||||
|
const comment = [
|
||||||
|
`👋 Hi @${author},`,
|
||||||
|
``,
|
||||||
|
`This pull request was closed because it does not follow the [PR template](${templateUrl}).`,
|
||||||
|
``,
|
||||||
|
`Please fix the following and open a new PR (or reopen this one after updating the description):`,
|
||||||
|
``,
|
||||||
|
failureList,
|
||||||
|
``,
|
||||||
|
`> Use the template sections, fill in the description, check all prerequisite boxes, and select at least one type of change.`,
|
||||||
|
``,
|
||||||
|
`Maintainers can add the \`keep open\` label to exempt a PR from this check.`,
|
||||||
|
``,
|
||||||
|
`Thank you for contributing! 🙏`,
|
||||||
|
].join("\n");
|
||||||
|
|
||||||
|
await github.rest.issues.createComment({
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
issue_number: prNumber,
|
||||||
|
body: comment,
|
||||||
|
});
|
||||||
|
|
||||||
|
await github.rest.pulls.update({
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
pull_number: prNumber,
|
||||||
|
state: "closed",
|
||||||
|
});
|
||||||
|
|
||||||
|
await github.rest.issues.addLabels({
|
||||||
|
owner,
|
||||||
|
repo,
|
||||||
|
issue_number: prNumber,
|
||||||
|
labels: ["missing pr template"],
|
||||||
|
});
|
||||||
+6
-29
@@ -3753,19 +3753,18 @@ run_addon_updates() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
runtime_script_status_guard() {
|
runtime_script_status_guard() {
|
||||||
local mode="${1:-}"
|
|
||||||
local script_slug="${SCRIPT_SLUG:-${NSAPP:-}}"
|
local script_slug="${SCRIPT_SLUG:-${NSAPP:-}}"
|
||||||
script_slug="$(echo "$script_slug" | tr '[:upper:]' '[:lower:]' | tr ' ' '-')"
|
script_slug="$(echo "$script_slug" | tr '[:upper:]' '[:lower:]' | tr ' ' '-')"
|
||||||
[[ -z "$script_slug" ]] && return 0
|
[[ -z "$script_slug" ]] && return 0
|
||||||
|
|
||||||
local api_url="https://db.community-scripts.org/api/collections/script_scripts/records?filter=(slug='${script_slug}')&perPage=1&fields=slug,is_disabled,is_deleted,disable_message,deleted_message,pinned_version,pin_reason"
|
local api_url="https://db.community-scripts.org/api/collections/script_scripts/records?filter=(slug='${script_slug}')&perPage=1&fields=slug,is_disabled,is_deleted,disable_message,deleted_message"
|
||||||
local response
|
local response
|
||||||
if ! response=$(curl -fsSL --connect-timeout 2 --max-time 3 "$api_url" 2>/dev/null); then
|
if ! response=$(curl -fsSL --connect-timeout 2 --max-time 3 "$api_url" 2>/dev/null); then
|
||||||
msg_warn "Script status check is unavailable. Continuing without status verification."
|
msg_warn "Script status check is unavailable. Continuing without status verification."
|
||||||
return 0
|
return 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
local is_deleted is_disabled deleted_message disable_message pinned_version pin_reason info_url
|
local is_deleted is_disabled deleted_message disable_message info_url
|
||||||
if printf '%s' "$response" | grep -qE '"items":[[:space:]]*\[[[:space:]]*\]'; then
|
if printf '%s' "$response" | grep -qE '"items":[[:space:]]*\[[[:space:]]*\]'; then
|
||||||
return 0
|
return 0
|
||||||
fi
|
fi
|
||||||
@@ -3775,8 +3774,6 @@ runtime_script_status_guard() {
|
|||||||
is_disabled=$(printf '%s' "$response" | sed -n 's/.*"is_disabled"[[:space:]]*:[[:space:]]*\(true\|false\).*/\1/p' | head -1)
|
is_disabled=$(printf '%s' "$response" | sed -n 's/.*"is_disabled"[[:space:]]*:[[:space:]]*\(true\|false\).*/\1/p' | head -1)
|
||||||
deleted_message=$(printf '%s' "$response" | sed -n 's/.*"deleted_message"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' | head -1)
|
deleted_message=$(printf '%s' "$response" | sed -n 's/.*"deleted_message"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' | head -1)
|
||||||
disable_message=$(printf '%s' "$response" | sed -n 's/.*"disable_message"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' | head -1)
|
disable_message=$(printf '%s' "$response" | sed -n 's/.*"disable_message"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' | head -1)
|
||||||
pinned_version=$(printf '%s' "$response" | sed -n 's/.*"pinned_version"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' | head -1)
|
|
||||||
pin_reason=$(printf '%s' "$response" | sed -n 's/.*"pin_reason"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' | head -1)
|
|
||||||
is_deleted=${is_deleted:-false}
|
is_deleted=${is_deleted:-false}
|
||||||
is_disabled=${is_disabled:-false}
|
is_disabled=${is_disabled:-false}
|
||||||
info_url="https://community-scripts.org/scripts/${script_slug}"
|
info_url="https://community-scripts.org/scripts/${script_slug}"
|
||||||
@@ -3808,26 +3805,6 @@ runtime_script_status_guard() {
|
|||||||
return 1
|
return 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "$mode" == "update" && -n "$pinned_version" && -n "${NSAPP:-}" ]]; then
|
|
||||||
local current_file="$HOME/.${NSAPP}"
|
|
||||||
if [[ -f "$current_file" ]]; then
|
|
||||||
local installed pinned_clean installed_clean
|
|
||||||
installed="$(<"$current_file")"
|
|
||||||
pinned_clean="$pinned_version"
|
|
||||||
installed_clean="$installed"
|
|
||||||
[[ "$pinned_clean" =~ ^v[0-9] ]] && pinned_clean="${pinned_clean:1}"
|
|
||||||
[[ "$installed_clean" =~ ^v[0-9] ]] && installed_clean="${installed_clean:1}"
|
|
||||||
if [[ "$installed_clean" == "$pinned_clean" ]]; then
|
|
||||||
if [[ -n "$pin_reason" ]]; then
|
|
||||||
msg_info "You are already on the pinned version (${pinned_version}). ${pin_reason}"
|
|
||||||
else
|
|
||||||
msg_info "You are already on the pinned version (${pinned_version}). No newer update is offered intentionally — please do not open an issue unless you see an actual error."
|
|
||||||
fi
|
|
||||||
msg_info "More info: ${info_url}"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -3843,7 +3820,7 @@ runtime_script_status_guard() {
|
|||||||
start() {
|
start() {
|
||||||
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/tools.func)
|
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/tools.func)
|
||||||
if command -v pveversion >/dev/null 2>&1; then
|
if command -v pveversion >/dev/null 2>&1; then
|
||||||
runtime_script_status_guard install || return 0
|
runtime_script_status_guard || return 0
|
||||||
install_script || return 0
|
install_script || return 0
|
||||||
return 0
|
return 0
|
||||||
elif [ ! -z ${PHS_SILENT+x} ] && [[ "${PHS_SILENT}" == "1" ]]; then
|
elif [ ! -z ${PHS_SILENT+x} ] && [[ "${PHS_SILENT}" == "1" ]]; then
|
||||||
@@ -3851,7 +3828,7 @@ start() {
|
|||||||
set_std_mode
|
set_std_mode
|
||||||
ensure_profile_loaded
|
ensure_profile_loaded
|
||||||
get_lxc_ip
|
get_lxc_ip
|
||||||
runtime_script_status_guard update || return 0
|
runtime_script_status_guard || return 0
|
||||||
update_script
|
update_script
|
||||||
run_addon_updates
|
run_addon_updates
|
||||||
update_motd_ip
|
update_motd_ip
|
||||||
@@ -3862,7 +3839,7 @@ start() {
|
|||||||
set_std_mode
|
set_std_mode
|
||||||
ensure_profile_loaded
|
ensure_profile_loaded
|
||||||
get_lxc_ip
|
get_lxc_ip
|
||||||
runtime_script_status_guard update || return 0
|
runtime_script_status_guard || return 0
|
||||||
update_script
|
update_script
|
||||||
run_addon_updates
|
run_addon_updates
|
||||||
update_motd_ip
|
update_motd_ip
|
||||||
@@ -3892,7 +3869,7 @@ start() {
|
|||||||
esac
|
esac
|
||||||
ensure_profile_loaded
|
ensure_profile_loaded
|
||||||
get_lxc_ip
|
get_lxc_ip
|
||||||
runtime_script_status_guard update || return 0
|
runtime_script_status_guard || return 0
|
||||||
update_script
|
update_script
|
||||||
run_addon_updates
|
run_addon_updates
|
||||||
update_motd_ip
|
update_motd_ip
|
||||||
|
|||||||
Reference in New Issue
Block a user