|
| 1 | +name: Build/Integration Issue |
| 2 | +description: Report problems with the build system, CMake, Zephyr integration, or toolchain |
| 3 | +title: "[BUILD]: " |
| 4 | +labels: ["build", "integration"] |
| 5 | +body: |
| 6 | + - type: markdown |
| 7 | + attributes: |
| 8 | + value: | |
| 9 | + Use this template for issues related to building, compiling, linking, or integrating the F Prime Zephyr project. |
| 10 | +
|
| 11 | + - type: dropdown |
| 12 | + id: build-stage |
| 13 | + attributes: |
| 14 | + label: Build Stage |
| 15 | + description: At what stage does the build fail? |
| 16 | + options: |
| 17 | + - Submodule initialization (make submodules) |
| 18 | + - Python environment setup (make fprime-venv) |
| 19 | + - Zephyr setup (make zephyr-setup) |
| 20 | + - F Prime generation (make generate) |
| 21 | + - Build/Compilation (make build) |
| 22 | + - Linking |
| 23 | + - Flashing/Upload |
| 24 | + - Runtime/Execution |
| 25 | + - Testing (make test-integration) |
| 26 | + - Other (specify in description) |
| 27 | + validations: |
| 28 | + required: true |
| 29 | + |
| 30 | + - type: textarea |
| 31 | + id: system-info |
| 32 | + attributes: |
| 33 | + label: Build System/Tool Versions |
| 34 | + description: Provide version information for your build environment |
| 35 | + placeholder: | |
| 36 | + - OS: Ubuntu 22.04 / macOS 14.0 / Windows 11 + WSL2 |
| 37 | + - Python version: 3.13.0 (from `python --version`) |
| 38 | + - CMake version: 3.28.0 (from `cmake --version`) |
| 39 | + - GCC/ARM toolchain: (from `arm-none-eabi-gcc --version` or Zephyr SDK version) |
| 40 | + - UV version: 0.8.13 (from `uv --version`) |
| 41 | + - F Prime version: v4.0.0a1 (from lib/fprime/ git tag) |
| 42 | + - Zephyr version: v4.2.0 (from west.yml) |
| 43 | + - Make version: (from `make --version`) |
| 44 | + validations: |
| 45 | + required: true |
| 46 | + |
| 47 | + - type: textarea |
| 48 | + id: build-configuration |
| 49 | + attributes: |
| 50 | + label: Build Configuration |
| 51 | + description: What is your build configuration? |
| 52 | + placeholder: | |
| 53 | + - Board: proves_flight_control_board_v5d/rp2350a/m33 |
| 54 | + - Build type: Release |
| 55 | + - Custom CMake options: (if any) |
| 56 | + - Environment variables: (if any special settings) |
| 57 | + - Settings from settings.ini: (if modified) |
| 58 | + validations: |
| 59 | + required: true |
| 60 | + |
| 61 | + - type: textarea |
| 62 | + id: error-messages |
| 63 | + attributes: |
| 64 | + label: Error Messages |
| 65 | + description: Paste the complete error output from the build |
| 66 | + placeholder: | |
| 67 | + ``` |
| 68 | + [build output here] |
| 69 | + ``` |
| 70 | + render: shell |
| 71 | + validations: |
| 72 | + required: true |
| 73 | + |
| 74 | + - type: textarea |
| 75 | + id: cmake-snippet |
| 76 | + attributes: |
| 77 | + label: Relevant CMakeLists.txt Snippet |
| 78 | + description: If the issue relates to CMake configuration, paste the relevant section |
| 79 | + placeholder: | |
| 80 | + ```cmake |
| 81 | + # From FprimeZephyrReference/Components/MyComponent/CMakeLists.txt |
| 82 | + register_fprime_module() |
| 83 | + add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Drv/") |
| 84 | + ``` |
| 85 | + render: cmake |
| 86 | + |
| 87 | + - type: textarea |
| 88 | + id: prjconf-snippet |
| 89 | + attributes: |
| 90 | + label: Relevant prj.conf Snippet |
| 91 | + description: If the issue relates to Zephyr configuration, paste the relevant section |
| 92 | + placeholder: | |
| 93 | + ``` |
| 94 | + # From prj.conf |
| 95 | + CONFIG_USB_DEVICE_STACK=y |
| 96 | + CONFIG_USB_CDC_ACM=y |
| 97 | + CONFIG_I2C=y |
| 98 | + ``` |
| 99 | + render: shell |
| 100 | + |
| 101 | + - type: textarea |
| 102 | + id: reproduction-steps |
| 103 | + attributes: |
| 104 | + label: Steps to Reproduce |
| 105 | + description: Provide exact steps to reproduce the build issue |
| 106 | + placeholder: | |
| 107 | + 1. Fresh clone: `git clone https://github.com/Open-Source-Space-Foundation/proves-core-reference` |
| 108 | + 2. Run: `make submodules` |
| 109 | + 3. Run: `make fprime-venv` |
| 110 | + 4. Run: `make zephyr-setup` |
| 111 | + 5. Run: `make generate` |
| 112 | + 6. Run: `make build` |
| 113 | + 7. Error occurs at step 6... |
| 114 | + validations: |
| 115 | + required: true |
| 116 | + |
| 117 | + - type: dropdown |
| 118 | + id: clean-build |
| 119 | + attributes: |
| 120 | + label: Clean Build Test |
| 121 | + description: Did you try a clean build? |
| 122 | + options: |
| 123 | + - "Yes, I ran 'make clean' and rebuilt" |
| 124 | + - "No, I haven't tried a clean build yet" |
| 125 | + - "Not applicable" |
| 126 | + validations: |
| 127 | + required: true |
| 128 | + |
| 129 | + - type: textarea |
| 130 | + id: workaround |
| 131 | + attributes: |
| 132 | + label: Workaround |
| 133 | + description: Have you found any workarounds for this issue? |
| 134 | + placeholder: | |
| 135 | + Setting environment variable XYZ=123 allows the build to proceed, but... |
| 136 | +
|
| 137 | + - type: textarea |
| 138 | + id: build-logs |
| 139 | + attributes: |
| 140 | + label: Additional Build Logs |
| 141 | + description: If available, paste additional logs (CMake configure output, verbose build output) |
| 142 | + placeholder: | |
| 143 | + ``` |
| 144 | + # Output from: make build VERBOSE=1 |
| 145 | + ``` |
| 146 | + render: shell |
| 147 | + |
| 148 | + - type: dropdown |
| 149 | + id: affects-ci |
| 150 | + attributes: |
| 151 | + label: Affects CI/CD |
| 152 | + description: Does this issue affect continuous integration builds? |
| 153 | + options: |
| 154 | + - "Yes, CI builds are failing" |
| 155 | + - "No, only affects local builds" |
| 156 | + - "Unknown" |
| 157 | + |
| 158 | + - type: textarea |
| 159 | + id: additional-context |
| 160 | + attributes: |
| 161 | + label: Additional Context |
| 162 | + description: Any other relevant information about the build issue |
| 163 | + placeholder: | |
| 164 | + This issue started after: |
| 165 | + - Updating to latest main branch |
| 166 | + - Installing new Zephyr SDK version |
| 167 | + - Changing board configuration |
| 168 | + ... |
0 commit comments