From 26f7d3345e33d583af0bb7fac8f179c574782fd9 Mon Sep 17 00:00:00 2001 From: Lan Tian Date: Mon, 8 Jun 2026 19:07:09 -0700 Subject: [PATCH] Add binary cache miss issue template to guide diagnosis, remove old build failure template no longer applicable --- .github/ISSUE_TEMPLATE/binary-cache-miss.yml | 45 +++++++++++++++++++ .github/ISSUE_TEMPLATE/build-failure.yml | 46 -------------------- 2 files changed, 45 insertions(+), 46 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/binary-cache-miss.yml delete mode 100644 .github/ISSUE_TEMPLATE/build-failure.yml diff --git a/.github/ISSUE_TEMPLATE/binary-cache-miss.yml b/.github/ISSUE_TEMPLATE/binary-cache-miss.yml new file mode 100644 index 0000000..b956ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/binary-cache-miss.yml @@ -0,0 +1,45 @@ +name: Binary Cache Miss Report +description: Report a binary cache miss issue +title: '[Binary Cache Miss] ' +labels: ['binary-cache-miss'] +body: + - type: markdown + attributes: + value: | + ## ⚠️ Before You Submit + + If you run into an issue with my provided binary cache, it's often caused by the kernel evaluated differently than what is in this repository. + + Here are some common steps you can try to fix the issue: + + - Use the `release` branch instead of `master` branch. `release` branch contains kernels that are built by my CI and cached. + - Use the `nix-cachyos-kernel.overlays.pinned` overlay instead of `default`. The `pinned` overlay uses nixpkgs from this repo. + - Make sure you are not overriding the `nixpkgs` input of this flake, such as `inputs.nixpkgs.follows = "..."`. + + This flake should be imported exactly as: + + ```nix + inputs = { + nix-cachyos-kernel.url = "github:xddxdd/nix-cachyos-kernel/release"; + }; + ``` + + - type: checkboxes + id: confirmation + attributes: + label: Please confirm the following before submitting an issue + options: + - label: I am using the `release` branch (`github:xddxdd/nix-cachyos-kernel/release`) + required: true + - label: I am using `nix-cachyos-kernel.overlays.pinned` (not `overlays.default`) + required: true + - label: I am not overriding inputs of this flake + required: true + + - type: textarea + id: description + attributes: + label: Issue Description + description: Describe the issue you are running into. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/build-failure.yml b/.github/ISSUE_TEMPLATE/build-failure.yml deleted file mode 100644 index c374605..0000000 --- a/.github/ISSUE_TEMPLATE/build-failure.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: Build Failure Report -description: Report a kernel build failure (please read carefully before submitting) -title: '[Build Failure] ' -labels: ['build-failure'] -body: - - type: markdown - attributes: - value: | - ## ⚠️ Before You Submit - - Most kernel build failures are caused by version mismatch between CachyOS patches and nixpkgs kernel version. - - If this is the case, the build will be automatically fixed once the versions to be in sync again. - - Please consider using the `release` branch as it contains the last successful build: - - ```nix - { - inputs = { - nix-cachyos-kernel.url = "github:xddxdd/nix-cachyos-kernel/release"; - } - } - ``` - - - type: checkboxes - id: confirmation - attributes: - label: Please confirm the following before submitting an issue - description: | - Only submit an issue if the build has been failing for multiple consecutive days, or if it's failing on the `release` branch. - - options: - - label: I understand that most build failures are caused by version mismatch between CachyOS patches and nixpkgs kernel version - required: true - - label: I understand that in most cases, the build will be automatically fixed once the versions to be in sync again - required: true - - label: The build has been failing for multiple consecutive days, OR it is failing on the `release` branch - required: true - - - type: textarea - id: description - attributes: - label: Issue Description - description: Describe the build failure (kernel variant, duration, error summary, etc.) - validations: - required: true