diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 000000000..f79a823d7
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,16 @@
+; editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+continuation_indent_size = 2
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+tab_width = 2
+; trim_trailing_whitespace = true ; disabled until files are cleaned up
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 000000000..b25e618ad
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1,17 @@
+#
+# CODEOWNERS for ProxmoxVE
+#
+
+# Order is important; the last matching pattern takes the most
+# precedence.
+
+
+# Codeowners for specific folders and files
+# Remember ending folders with /
+
+
+# Set default reviewers
+* @community-scripts/Contributor
+
+# All changes in frontend
+/frontend/ @community-scripts/Frontend-Dev
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 000000000..b000bd25e
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+
+Contributing to Proxmox VE Helper Scripts
+
+Everybody is invited and welcome to contribute to Proxmox VE Helper Scripts.
+
+- Pull requests submitted against [**main**](https://github.com/community-scripts/ProxmoxVE/tree/main) are meticulously scrutinized, so please do not take it personally if the project maintainer rejects your request. By adhering to the established patterns and conventions throughout the codebase, you greatly increase the likelihood that your changes will get merged into [**main**](https://github.com/community-scripts/ProxmoxVE/tree/main).
+
+- It is important to stress that complaining about a decision after it has been made is not productive behavior for the pull request submitter. It is crucial for all contributors to respect the decision-making process and collaborate effectively towards achieving the best possible outcome for the project.
+
+- The repository will only accept Alpine applications that make use of the Alpine Package Keeper.
diff --git a/.github/DISCUSSION_TEMPLATE/request-script.yml b/.github/DISCUSSION_TEMPLATE/request-script.yml
new file mode 100644
index 000000000..aac84df60
--- /dev/null
+++ b/.github/DISCUSSION_TEMPLATE/request-script.yml
@@ -0,0 +1,37 @@
+title: "[Script request] "
+labels: ["enhancement"]
+body:
+- type: input
+ attributes:
+ label: Application Name
+ description: Enter the application name.
+ placeholder: "e.g., Home Assistant"
+ validations:
+ required: true
+- type: input
+ attributes:
+ label: Website
+ description: Official website or github page.
+ placeholder: "e.g., https://www.home-assistant.io/"
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: Description
+ description: Explain what the application does and why it should be added to Proxmox VE Helper-Scripts.
+ placeholder: "e.g., Home Assistant is a popular open-source platform that brings all your smart home devices together in one place. Adding it to Proxmox VE Helper-Scripts would make setup and management on Proxmox easy, letting users quickly get a powerful, self-hosted smart home system up and running."
+ validations:
+ required: true
+- type: checkboxes
+ attributes:
+ label: Due Diligence
+ options:
+ - label: "I have searched existing [scripts](https://community-scripts.github.io/Proxmox/scripts) and found no duplicates."
+ required: true
+ - label: "I have searched existing [discussions](https://github.com/community-scripts/ProxmoxVE/discussions?discussions_q=) and found no duplicate requests."
+ required: true
+ - label: "This is not a game-related request."
+ required: true
+- type: markdown
+ attributes:
+ value: "Thanks for submitting your request! The team will review it and reach out if we need more information."
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 000000000..5f1f19727
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1 @@
+ko_fi: community_scripts
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..f450b99b1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,100 @@
+name: "🐞 Script Issue Report"
+description: Report a specific issue with a script. For other inquiries, please use the Discussions section.
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ # 🐞 **Script Issue Report**
+ Thank you for taking the time to report an issue! Please provide as much detail as possible to help us address the problem efficiently.
+
+ ## ⚠️ **IMPORTANT**
+ - 🔍 **Search first:** Before submitting, check if the issue has already been reported or resolved in [closed issues](https://github.com/community-scripts/ProxmoxVE/issues?q=is%3Aissue+is%3Aclosed). If found, comment on that issue instead of creating a new one.
+ Alternatively, check the **[Discussions](https://github.com/community-scripts/ProxmoxVE/discussions)** under the *"Announcement"* or *"Guide"* categories for relevant information.
+ - 🛠️ **Supported environments only:** Ensure you are using a default Linux distribution. Custom setups may not be supported.
+ - 🔎 If you encounter `[ERROR] in line 23: exit code *: while executing command "$@" > /dev/null 2>&1`, rerun the script with verbose mode before submitting the issue.
+ - 💡 For general questions, feature requests, or suggestions, use the [Discussions section](https://github.com/community-scripts/ProxmoxVE/discussions).
+
+ - type: input
+ id: guidelines
+ attributes:
+ label: ✅ Have you read and understood the above guidelines?
+ placeholder: "yes"
+ validations:
+ required: true
+
+ - type: input
+ id: script_name
+ attributes:
+ label: 📜 What is the name of the script you are using?
+ placeholder: "e.g., NextcloudPi, Zigbee2MQTT"
+ validations:
+ required: true
+
+ - type: input
+ id: script_command
+ attributes:
+ label: 📂 What was the exact command used to execute the script?
+ placeholder: "e.g., bash -c \"$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/zigbee2mqtt.sh)\" or \"update\""
+ validations:
+ required: true
+
+ - type: textarea
+ id: issue_description
+ attributes:
+ label: 📝 Provide a clear and concise description of the issue.
+ validations:
+ required: true
+
+ - type: checkboxes
+ validations:
+ required: true
+ attributes:
+ label: ⚙️ What settings are you using?
+ options:
+ - label: Default Settings
+ - label: Advanced Settings
+
+ - type: markdown
+ attributes:
+ value: "💡 **Tip:** If you are using Advanced Settings, please test with Default Settings before submitting an issue."
+
+ - type: dropdown
+ id: linux_distribution
+ attributes:
+ label: 🖥️ Which Linux distribution are you using?
+ options:
+ -
+ - Alpine
+ - Debian 11
+ - Debian 12
+ - Ubuntu 20.04
+ - Ubuntu 22.04
+ - Ubuntu 24.04
+ - Ubuntu 24.10
+ validations:
+ required: true
+
+ - type: textarea
+ id: steps_to_reproduce
+ attributes:
+ label: 🔄 Steps to reproduce the issue.
+ placeholder: "e.g., Step 1: ..., Step 2: ..."
+ validations:
+ required: true
+
+ - type: textarea
+ id: error_output
+ attributes:
+ label: ❌ Paste the full error output (if available).
+ placeholder: "Include any relevant logs or error messages."
+ validations:
+ required: true
+
+ - type: textarea
+ id: additional_context
+ attributes:
+ label: 🖼️ Additional context (optional).
+ placeholder: "Include screenshots, code blocks (use triple backticks ```), or any other relevant information."
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..e9a13bc4d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+ - name: 🤔 Questions and Help
+ url: https://github.com/community-scripts/ProxmoxVE/discussions
+ about: For suggestions or questions, please use the Discussions section.
+ - name: 🌟 Feature request
+ url: https://github.com/community-scripts/ProxmoxVE/discussions/new?category=request-script
+ about: For feature/script requests, please use the Discussions section.
+ - name: 💻 Discord
+ url: https://discord.gg/UHrpNWGwkH
+ about: Join our Discord server to chat with other users in the Proxmox Helper Scripts community.
diff --git a/.github/ISSUE_TEMPLATE/frontend_report.yml b/.github/ISSUE_TEMPLATE/frontend_report.yml
new file mode 100644
index 000000000..2a6f20af0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/frontend_report.yml
@@ -0,0 +1,75 @@
+name: "🌐 Website Issue Report"
+description: Report an issue, an optimization request or an documentation issue specifically related to the website.
+labels: "website"
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ **IMPORTANT:** Failure to comply with the following guidelines may result in immediate closure.
+ - Prior to submitting, kindly search the closed issues to check if the problem you are reporting has already been addressed and resolved. If you come across a closed issue that pertains to your problem, please leave a comment on that issue instead of creating a new one.
+ - If the problem is related to a bug in the website, kindly check for browser compatibility and ensure the issue occurs in multiple browsers before submitting.
+ - For suggestions, questions, or feature requests, please use the [Discussions section.](https://github.com/community-scripts/ProxmoxVE/discussions)
+
+ - type: input
+ id: guidelines
+ attributes:
+ label: Please verify that you have read and understood the guidelines.
+ placeholder: 'yes'
+ validations:
+ required: true
+
+ - type: dropdown
+ id: issue_type
+ validations:
+ required: true
+ attributes:
+ label: What type of issue is this?
+ options:
+ -
+ - Bug
+ - Optimization
+ - Documentation
+ - Other
+
+ - type: textarea
+ id: bug_description
+ attributes:
+ label: A clear and concise description of the issue.
+ validations:
+ required: true
+
+ - type: dropdown
+ id: browser
+ validations:
+ required: true
+ attributes:
+ label: Which browser are you using?
+ options:
+ -
+ - Chrome
+ - Firefox
+ - Safari
+ - Edge
+ - Other
+
+ - type: markdown
+ attributes:
+ value: |
+ **If the issue is browser-related**, please provide information on the version and platform (Windows, MacOS, Linux, etc.).
+
+ - type: textarea
+ id: screenshot
+ attributes:
+ label: If relevant, including screenshots or a code block can be helpful in clarifying the issue.
+ placeholder: "Code blocks begin and conclude by enclosing the code with three backticks (```) above and below it."
+ validations:
+ required: false
+
+ - type: textarea
+ id: reproduce
+ attributes:
+ label: Please provide detailed steps to reproduce the issue.
+ placeholder: "First do this, then this ..."
+ validations:
+ required: false
diff --git a/.github/autolabeler-config.json b/.github/autolabeler-config.json
new file mode 100644
index 000000000..4485d62c9
--- /dev/null
+++ b/.github/autolabeler-config.json
@@ -0,0 +1,64 @@
+
+{
+ "breaking change": [
+ {
+ "fileStatus": "renamed",
+ "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"],
+ "excludeGlobs": []
+ },
+ {
+ "fileStatus": "removed",
+ "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"],
+ "excludeGlobs": []
+ }
+ ],
+ "new script": [
+ {
+ "fileStatus": "added",
+ "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"],
+ "excludeGlobs": []
+ }
+ ],
+ "update script": [
+ {
+ "fileStatus": "modified",
+ "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"],
+ "excludeGlobs": ["misc/build.func", "misc/install.func"]
+ }
+ ],
+ "delete script": [
+ {
+ "fileStatus": "removed",
+ "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"],
+ "excludeGlobs": []
+ }
+ ],
+ "rename script": [
+ {
+ "fileStatus": "renamed",
+ "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"],
+ "excludeGlobs": []
+ }
+ ],
+ "website": [
+ {
+ "fileStatus": null,
+ "includeGlobs": ["frontend/**", "json/**"],
+ "excludeGlobs": []
+ }
+ ],
+ "maintenance": [
+ {
+ "fileStatus": null,
+ "includeGlobs": ["*.md", ".github/**"],
+ "excludeGlobs": []
+ }
+ ],
+ "high risk": [
+ {
+ "fileStatus": null,
+ "includeGlobs": ["misc/build.func", "misc/install.func"],
+ "excludeGlobs": []
+ }
+ ]
+}
\ No newline at end of file
diff --git a/.github/changelog-pr-config.json b/.github/changelog-pr-config.json
new file mode 100644
index 000000000..5da6b306a
--- /dev/null
+++ b/.github/changelog-pr-config.json
@@ -0,0 +1,30 @@
+[
+ {
+ "title": "💥 Breaking Changes",
+ "labels": ["breaking change"]
+ },
+ {
+ "title": "✨ New Scripts",
+ "labels": ["new script"]
+ },
+ {
+ "title": "🚀 Updated Scripts",
+ "labels": ["update script"]
+ },
+ {
+ "title": "🌐 Website",
+ "labels": ["website"]
+ },
+ {
+ "title": "🐞 Bug Fixes",
+ "labels": ["bug fix"]
+ },
+ {
+ "title": "🧰 Maintenance",
+ "labels": ["maintenance"]
+ },
+ {
+ "title": "❔ Unlabelled",
+ "labels": []
+ }
+]
diff --git a/.github/check-script.yml b/.github/check-script.yml
new file mode 100644
index 000000000..560bc3965
--- /dev/null
+++ b/.github/check-script.yml
@@ -0,0 +1,54 @@
+name: Check Shell Scripts
+
+on:
+ pull_request:
+ paths:
+ - '**/*.sh' # Führt den Check nur für Shell-Skripte aus
+
+jobs:
+ check-scripts:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v3
+
+ - name: Check `source` Line in Scripts
+ shell: bash
+ run: |
+ set -e
+ ERROR_COUNT=0
+ FILES=$(find . -name "*.sh")
+
+ for FILE in $FILES; do
+ # Check for exact match of the source line in line 2
+ if [[ $(sed -n '2p' "$FILE") =~ ^source[[:space:]]+<(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func) ]]; then
+ echo "Check passed for: $FILE"
+ else
+ echo "Error in $FILE: Line 2 must be exactly 'source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)' if a source line is used."
+ ERROR_COUNT=$((ERROR_COUNT + 1))
+ fi
+
+ # Check for shebang line at the top
+ if [[ $(head -n 1 "$FILE") != "#!/usr/bin/env bash" ]]; then
+ echo "Error in $FILE: The first line must be '#!/usr/bin/env bash'."
+ ERROR_COUNT=$((ERROR_COUNT + 1))
+ fi
+
+ # Check for executable permissions
+ if [[ ! -x "$FILE" ]]; then
+ echo "Warning in $FILE: This script is not executable. Consider running 'chmod +x $FILE'."
+ fi
+
+ # Check for empty lines at the beginning of the script
+ if [[ $(head -n 10 "$FILE" | grep -c '^$') -gt 0 ]]; then
+ echo "Warning in $FILE: There are empty lines at the beginning of the script. Consider removing them."
+ fi
+ done
+
+ if [[ "$ERROR_COUNT" -gt 0 ]]; then
+ echo "$ERROR_COUNT script(s) failed validation."
+ exit 1
+ else
+ echo "All scripts passed."
+ fi
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..8e2f5b0bc
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,39 @@
+> **🛠️ Note:**
+> We are meticulous about merging code into the main branch, so please understand that pull requests not meeting the project's standards may be rejected. It's never personal!
+> 🎮 **Note for game-related scripts:** These have a lower likelihood of being merged.
+
+---
+
+## ✍️ Description
+Provide a summary of the changes made and/or reference the issue being addressed.
+
+
+
+- - -
+**_Please remove unneeded lines!_**
+- Related Issue: # (issue number, if applicable)
+- Related PR: # (if applicable)
+- Related Discussion: []()(if applicable)
+
+---
+
+## 🛠️ Type of Change
+Please check the relevant options:
+- [ ] Bug fix (non-breaking change that resolves an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change unexpectedly)
+- [ ] New script (a fully functional and thoroughly tested script or set of scripts)
+
+---
+
+## ✅ Prerequisites
+The following steps must be completed for the pull request to be considered:
+- [ ] Self-review performed (I have reviewed my code to ensure it follows established patterns and conventions.)
+- [ ] Testing performed (I have thoroughly tested my changes and verified expected functionality.)
+- [ ] Documentation updated (I have updated any relevant documentation)
+
+---
+
+## 📋 Additional Information (optional)
+Provide any extra context or screenshots about the feature or fix here.
+
diff --git a/.github/workflows/autolabeler.yml b/.github/workflows/autolabeler.yml
new file mode 100644
index 000000000..660135f5c
--- /dev/null
+++ b/.github/workflows/autolabeler.yml
@@ -0,0 +1,62 @@
+name: Auto Label Pull Requests
+
+on:
+ pull_request_target:
+ branches: ["main"]
+ types: [opened, synchronize, reopened, edited]
+
+jobs:
+ autolabeler:
+ runs-on: ubuntu-latest
+ permissions:
+ pull-requests: write
+ env:
+ CONFIG_PATH: .github/autolabeler-config.json
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Install minimatch
+ run: npm install minimatch
+
+ - name: Label PR based on config rules
+ uses: actions/github-script@v7
+ with:
+ script: |
+ const fs = require('fs').promises;
+ const path = require('path');
+ const { minimatch } = require('minimatch');
+
+ const configPath = path.resolve(process.env.CONFIG_PATH);
+ const fileContent = await fs.readFile(configPath, 'utf-8');
+ const autolabelerConfig = JSON.parse(fileContent);
+
+ const prNumber = context.payload.pull_request.number;
+ const prListFilesResponse = await github.rest.pulls.listFiles({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ pull_number: prNumber,
+ });
+ const prFiles = prListFilesResponse.data;
+
+ for (const [label, rules] of Object.entries(autolabelerConfig)) {
+ const shouldAddLabel = prFiles.some((prFile) => {
+ return rules.some((rule) => {
+ const isFileStatusMatch = rule.fileStatus ? rule.fileStatus === prFile.status : true;
+ const isIncludeGlobMatch = rule.includeGlobs.some((glob) => minimatch(prFile.filename, glob));
+ const isExcludeGlobMatch = rule.excludeGlobs.some((glob) => minimatch(prFile.filename, glob));
+
+ return isFileStatusMatch && isIncludeGlobMatch && !isExcludeGlobMatch;
+ });
+ });
+
+ if (shouldAddLabel) {
+ console.log(`Adding label ${label} to PR ${prNumber}`);
+ await github.rest.issues.addLabels({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ issue_number: prNumber,
+ labels: [label],
+ });
+ }
+ }
diff --git a/.github/workflows/changelog-pr.yml b/.github/workflows/changelog-pr.yml
new file mode 100644
index 000000000..78d74f856
--- /dev/null
+++ b/.github/workflows/changelog-pr.yml
@@ -0,0 +1,159 @@
+name: Create Changelog Pull Request
+
+on:
+ push:
+ branches: ["main"]
+ workflow_dispatch:
+
+jobs:
+ update-changelog-pull-request:
+ runs-on: ubuntu-latest
+ env:
+ CONFIG_PATH: .github/changelog-pr-config.json
+ BRANCH_NAME: github-action-update-changelog
+ AUTOMATED_PR_LABEL: "automated pr"
+ permissions:
+ contents: write
+ pull-requests: write
+ steps:
+ - name: Generate a token
+ id: generate-token
+ uses: actions/create-github-app-token@v1
+ with:
+ app-id: ${{ vars.APP_ID }}
+ private-key: ${{ secrets.APP_PRIVATE_KEY }}
+
+ - name: Checkout code
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: Get latest dates in changelog
+ run: |
+ # Extract the latest and second latest dates from changelog
+ DATES=$(grep '^## [0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}' CHANGELOG.md | head -n 2 | awk '{print $2}')
+
+ LATEST_DATE=$(echo "$DATES" | sed -n '1p')
+ SECOND_LATEST_DATE=$(echo "$DATES" | sed -n '2p')
+ TODAY=$(date -u +%Y-%m-%d)
+
+ echo "TODAY=$TODAY" >> $GITHUB_ENV
+ if [ "$LATEST_DATE" == "$TODAY" ]; then
+ echo "LATEST_DATE=$SECOND_LATEST_DATE" >> $GITHUB_ENV
+ else
+ echo "LATEST_DATE=$LATEST_DATE" >> $GITHUB_ENV
+ fi
+
+ - name: Get categorized pull requests
+ id: get-categorized-prs
+ uses: actions/github-script@v7
+ with:
+ script: |
+ const fs = require('fs').promises;
+ const path = require('path');
+
+ const configPath = path.resolve(process.env.CONFIG_PATH);
+ const fileContent = await fs.readFile(configPath, 'utf-8');
+ const changelogConfig = JSON.parse(fileContent);
+ const categorizedPRs = changelogConfig.map((obj) => ({ ...obj, notes: [] }));
+
+ const latestDateInChangelog = new Date(process.env.LATEST_DATE);
+ latestDateInChangelog.setUTCHours(23,59,59,999);
+
+ const { data: pulls } = await github.rest.pulls.list({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ base: "main",
+ state: "closed",
+ sort: "updated",
+ direction: "desc",
+ per_page: 100,
+ });
+
+ pulls.filter((pr) =>
+ pr.merged_at && new Date(pr.merged_at) > latestDateInChangelog
+ ).forEach((pr) => {
+ const prLabels = pr.labels.map((label) => label.name.toLowerCase());
+ const prNote = `- ${pr.title} [@${pr.user.login}](https://github.com/${pr.user.login}) ([#${pr.number}](${pr.html_url}))`;
+
+ for (const { labels, notes } of categorizedPRs) {
+ const prHasCategoryLabel = labels.some((label) => prLabels.includes(label));
+ const isUnlabelledCategory = labels.length === 0;
+ const prShouldBeExcluded = prLabels.includes(process.env.AUTOMATED_PR_LABEL);
+ if ((prHasCategoryLabel || isUnlabelledCategory) && !prShouldBeExcluded) {
+ notes.push(prNote);
+ break;
+ }
+ };
+ });
+
+ return categorizedPRs;
+
+ - name: Update CHANGELOG.md
+ uses: actions/github-script@v7
+ with:
+ script: |
+ const fs = require('fs').promises;
+ const path = require('path');
+
+ const today = process.env.TODAY;
+ const latestDateInChangelog = process.env.LATEST_DATE;
+ const changelogPath = path.resolve('CHANGELOG.md');
+ const categorizedPRs = ${{ steps.get-categorized-prs.outputs.result }};
+
+ let newReleaseNotes = `## ${today}\n\n### Changed\n\n`;
+ for (const { title, notes } of categorizedPRs) {
+ if (notes.length > 0) {
+ newReleaseNotes += `### ${title}\n\n${notes.join("\n")}\n\n`;
+ }
+ }
+
+ const changelogContent = await fs.readFile(changelogPath, 'utf-8');
+ const changelogIncludesTodaysReleaseNotes = changelogContent.includes(`\n## ${today}`);
+
+ // Replace todays release notes or insert release notes above previous release notes
+ const regex = changelogIncludesTodaysReleaseNotes ?
+ new RegExp(`## ${today}.*(?=## ${latestDateInChangelog})`, "gs") :
+ new RegExp(`(?=## ${latestDateInChangelog})`, "gs");
+
+ const newChangelogContent = changelogContent.replace(regex, newReleaseNotes)
+ await fs.writeFile(changelogPath, newChangelogContent);
+
+ - name: Check if there are any changes
+ id: verify-diff
+ run: |
+ git diff --quiet . || echo "changed=true" >> $GITHUB_OUTPUT
+
+ - name: Commit and push changes to separate branch
+ if: steps.verify-diff.outputs.changed == 'true'
+ run: |
+ git config --global user.name "github-actions[bot]"
+ git config --global user.email "github-actions[bot]@users.noreply.github.com"
+ git add CHANGELOG.md
+ git commit -m "Update CHANGELOG.md"
+ git checkout -b $BRANCH_NAME || git checkout $BRANCH_NAME
+ git push origin $BRANCH_NAME --force
+
+ - name: Create pull request if not exists
+ if: steps.verify-diff.outputs.changed == 'true'
+ env:
+ GH_TOKEN: ${{ steps.generate-token.outputs.token }}
+ run: |
+ PR_EXISTS=$(gh pr list --head "${BRANCH_NAME}" --json number --jq '.[].number')
+ if [ -z "$PR_EXISTS" ]; then
+ gh pr create --title "[Github Action] Update CHANGELOG.md" \
+ --body "This PR is auto-generated by a Github Action to update the CHANGELOG.md file." \
+ --head $BRANCH_NAME \
+ --base main \
+ --label "$AUTOMATED_PR_LABEL"
+ fi
+
+ - name: Approve pull request
+ if: steps.verify-diff.outputs.changed == 'true'
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: |
+ PR_NUMBER=$(gh pr list --head "${BRANCH_NAME}" --json number --jq '.[].number')
+ if [ -n "$PR_NUMBER" ]; then
+ gh pr review $PR_NUMBER --approve
+ fi
diff --git a/.github/workflows/frontend-cicd.yml b/.github/workflows/frontend-cicd.yml
new file mode 100644
index 000000000..dd242f6ef
--- /dev/null
+++ b/.github/workflows/frontend-cicd.yml
@@ -0,0 +1,78 @@
+# Based on https://github.com/actions/starter-workflows/blob/main/pages/nextjs.yml
+
+name: Frontend CI/CD
+
+on:
+ push:
+ branches: ["main"]
+ paths:
+ - frontend/**
+ - json/**
+
+ pull_request:
+ branches: ["main"]
+ types: [opened, synchronize, reopened, edited]
+ paths:
+ - frontend/**
+ - json/**
+
+ workflow_dispatch:
+
+permissions:
+ contents: read
+
+concurrency:
+ group: pages-${{ github.ref }}
+ cancel-in-progress: false
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ defaults:
+ run:
+ working-directory: frontend # Set default working directory for all run steps
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Setup Node
+ uses: actions/setup-node@v4
+ with:
+ node-version: "20"
+ cache: npm
+ cache-dependency-path: frontend/package-lock.json
+
+ - name: Install dependencies
+ run: npm ci --prefer-offline --legacy-peer-deps
+
+ - name: Run tests
+ run: npm run test
+
+ - name: Configure Next.js for pages
+ uses: actions/configure-pages@v5
+ with:
+ static_site_generator: next
+
+ - name: Build with Next.js
+ run: npm run build
+
+ - name: Upload artifact
+ if: github.ref == 'refs/heads/main'
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: frontend/out
+
+ deploy:
+ runs-on: ubuntu-latest
+ needs: build
+ if: github.ref == 'refs/heads/main'
+ permissions:
+ pages: write
+ id-token: write
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4
diff --git a/.github/workflows/github-release.yml b/.github/workflows/github-release.yml
new file mode 100644
index 000000000..eba622ff9
--- /dev/null
+++ b/.github/workflows/github-release.yml
@@ -0,0 +1,25 @@
+name: Create new release
+
+on:
+ schedule:
+ # Runs "At 00:01 every night" (UTC)
+ - cron: '1 0 * * *'
+
+jobs:
+ create-new-release:
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+ - name: Parse CHANGELOG.md for yesterday's entries and create a new release
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: |
+ YESTERDAY=$(date -u --date="yesterday" +%Y-%m-%d)
+ YESTERDAY_CHANGELOG_NOTES=$(awk '/^## '"$YESTERDAY"'/ {f=1; next} f && /^## [0-9]{4}-[0-9]{2}-[0-9]{2}/ {f=0} f && !/^## / {print}' CHANGELOG.md)
+
+ if [ -n "$YESTERDAY_CHANGELOG_NOTES" ]; then
+ gh release create "$YESTERDAY" -t "$YESTERDAY" -n "$YESTERDAY_CHANGELOG_NOTES" --latest
+ fi
diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml
new file mode 100644
index 000000000..842ebabd5
--- /dev/null
+++ b/.github/workflows/shellcheck.yml
@@ -0,0 +1,25 @@
+name: Shellcheck
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ workflow_dispatch:
+ schedule:
+ - cron: "5 1 * * *"
+
+jobs:
+ shellcheck:
+ name: Shellcheck
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Run ShellCheck
+ uses: ludeeus/action-shellcheck@master
+ with:
+ ignore_paths: >-
+ frontend
+ json
diff --git a/README.md b/README.md
index 4b1d1b52f..66a72bfd7 100644
--- a/README.md
+++ b/README.md
@@ -33,4 +33,4 @@ If you would like to offer support, I would appreciate a star on the repository,
## Compatibility Guide
-[View Compatibility Guide here](https://pimox-scripts.com)
\ No newline at end of file
+[View Compatibility Guide here](https://pimox-scripts.com)
+
+