diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 95eff9e..8b15bef 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,2 +1,3 @@ -github: [JSONbored] +github: + - JSONbored ko_fi: jsonbored diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..a147b4f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,30 @@ +name: Bug report +description: Report a problem with the AIO container, XML, or docs +title: "[Bug]: " +labels: + - bug +body: + - type: textarea + id: summary + attributes: + label: Summary + description: What is broken? + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Include Unraid version, image tag, and relevant settings diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..41dbdfa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,25 @@ +name: Feature request +description: Suggest an improvement to the template, AIO image, or Unraid CA experience +title: "[Feature]: " +labels: + - enhancement +body: + - type: textarea + id: problem + attributes: + label: Problem to solve + description: What is missing, confusing, or unnecessarily hard today? + validations: + required: true + - type: textarea + id: proposed + attributes: + label: Proposed improvement + description: Describe the change you want and why it would help. + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Include app-specific, Unraid-specific, or user-experience details that matter. diff --git a/.github/ISSUE_TEMPLATE/installation_help.yml b/.github/ISSUE_TEMPLATE/installation_help.yml new file mode 100644 index 0000000..89bbdaa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/installation_help.yml @@ -0,0 +1,32 @@ +name: Installation help +description: Get help with first-run setup, Unraid mapping choices, or upgrade behavior +title: "[Help]: " +labels: + - question +body: + - type: textarea + id: goal + attributes: + label: What are you trying to do? + description: Describe the install, upgrade, or configuration task you are working through. + validations: + required: true + - type: textarea + id: current + attributes: + label: What is happening now? + description: Include the exact symptom, error, or point where you got stuck. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Include Unraid version, image tag, relevant template values, and whether this is a fresh install or an upgrade. + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant logs or screenshots + description: Paste container logs or screenshots that will help reproduce the problem faster. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..470dbbb --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,14 @@ +## Summary + +- what changed +- why it changed + +## Validation + +- [ ] local smoke test passed +- [ ] docs updated if behavior changed +- [ ] XML updated if config surface changed + +## Risks + +- note any migration, data, or compatibility risk diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b9c986e..ac40cc0 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -26,7 +26,7 @@ on: run_smoke_test: description: "Run the smoke-test job" required: false - default: true + default: false type: boolean publish_image: description: "Publish image tags from the current ref" @@ -217,7 +217,7 @@ jobs: uses: actions/dependency-review-action@2031cfc080254a8a887f58cffee85186f0e49e48 # v4.9.0 smoke-test: - if: ${{ needs.detect-changes.outputs.build_related == 'true' && (github.event_name != 'workflow_dispatch' || inputs.run_smoke_test == true) }} + if: ${{ needs.detect-changes.outputs.build_related == 'true' && ((github.event_name == 'push' && github.ref == 'refs/heads/main') || (github.event_name == 'workflow_dispatch' && inputs.run_smoke_test == true)) }} needs: - detect-changes - validate-template diff --git a/SECURITY.md b/SECURITY.md index a4af1a7..7a1513e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,24 +2,25 @@ ## Supported Versions -Currently only the `latest` image tag and the primary branch are supported with security updates. +Only the `main` branch, the current `latest` image tag, and the current upstream-aligned version tags are supported with security fixes. -| Version | Supported | -| ------- | ------------------ | -| latest | :white_check_mark: | -| branch | :white_check_mark: | -| older | :x: | +| Version | Supported | +| ------- | --------- | +| main | yes | +| latest | yes | +| current upstream-aligned tags | yes | +| older | no | ## Reporting a Vulnerability Do not open public issues for suspected vulnerabilities. - Preferred: GitHub private vulnerability report for this repository -- Fallback: email **security@aethereal.dev** +- Fallback: email `security@aethereal.dev` Include: -- affected image tag or branch +- affected repo, branch, or image tag - reproduction steps - impact assessment -- any mitigation you have already confirmed +- any confirmed mitigation diff --git a/sure-aio.xml b/sure-aio.xml index 444ee83..dd41f30 100644 --- a/sure-aio.xml +++ b/sure-aio.xml @@ -25,8 +25,8 @@ The absolute easiest way to deploy Sure on Unraid. This is a "mega-container" th 3. Wait for the WebUI. Databases are auto-provisioned securely inside the container. Tools: Finance: Productivity: http://[IP]:[PORT:3000] - https://github.com/JSONbored/awesome-unraid/raw/master/sure-aio.xml - https://raw.githubusercontent.com/JSONbored/awesome-unraid/master/icons/sure.png + https://raw.githubusercontent.com/JSONbored/awesome-unraid/main/sure-aio.xml + https://raw.githubusercontent.com/JSONbored/awesome-unraid/main/icons/sure.png