Merge pull request janhq#3664 from janhq/dev

release: Jan Release cut v0.5.4

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -4,79 +4,40 @@ labels: [ "type: bug" ]
 title: 'bug: [DESCRIPTION]'
 
 body:
-  - type: markdown
-    attributes:
-      value: "Thanks for taking the time to fill out this bug report!"
-
-  - type: checkboxes
+  - type: input
+    validations:
+      required: true
     attributes:
-      label: "#"
-      description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
-      options:
-        - label: "I have searched the existing issues"
-          required: false
+      label: "Jan version"
+      description: "**Tip:** The version is in the app's bottom right corner"
+      placeholder: "e.g. 0.5.x-xxx"
 
   - type: textarea
     validations:
       required: true
     attributes:
-      label: "Current behavior"
-      description: "A clear and concise description of what the bug is"
+      label: "Describe the Bug"
+      description: "A clear & concise description of the bug"
 
   - type: textarea
-    validations:
-      required: true
     attributes:
-      label: "Minimum reproduction step"
+      label: "Steps to Reproduce"
       description: |
-        Please list out steps to reproduce the behavior
+        Please list out steps to reproduce the issue
       placeholder: |
         1. Go to '...'
-        2. Click on '....'
-        3. Scroll down to '....'
-        4. See error
-
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: "Expected behavior"
-      description: "A clear and concise description of what you expected to happen"
+        2. Click on '...'
 
   - type: textarea
-    validations:
-      required: true
     attributes:
       label: "Screenshots / Logs"
       description: |
-        Kindly provide your screenshots / [usage logs](https://jan.ai/docs/troubleshooting#how-to-get-error-logs) that could be helpful in diagnosing the problem
-        **Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in
-  - type: markdown
-    attributes:
-      value: |
-        ---
-
-  - type: input
-    validations:
-      required: true
-    attributes:
-      label: "Jan version"
-      description: "**Tip:** The version is located in the lower right conner of the Jan app"
-      placeholder: "e.g. 0.5.x-xxx nightly or stable"
+        You can find logs in: ~/jan/logs/app.logs
 
   - type: checkboxes
     attributes:
-      label: "In which operating systems have you tested?"
+      label: "What is your OS?"
       options:
-        - label: macOS
+        - label: MacOS
         - label: Windows
         - label: Linux
-
-  - type: textarea
-    attributes:
-      label: "Environment details"
-      description: |
-        - Operating System: [Specify your OS details: e.g., MacOS Sonoma 14.2.1, Windows 11, Ubuntu 22, etc]
-        - Processor: [e.g., Apple M1, Intel Core i7, AMD Ryzen 5, etc]
-        - RAM: [e.g., 8GB, 16GB]
-        - Any additional relevant hardware specifics: [e.g., Graphics card, SSD/HDD]

.github/ISSUE_TEMPLATE/config.yml

@@ -2,6 +2,6 @@
 blank_issues_enabled: true
 
 contact_links:
-  - name: "\u2753 Our GitHub Discussions page"
+  - name: "\1F4AC Jan Discussions"
     url: "https://github.com/orgs/janhq/discussions/categories/q-a"
-    about: "Please ask and answer questions here!"
+    about: "Get help, discuss features & roadmap, and share your projects"

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,44 +1,20 @@
 name: "\U0001F680 Feature Request"
 description: "Suggest an idea for this project \U0001F63B!"
-title: 'feat: [DESCRIPTION]'
+title: 'idea: [DESCRIPTION]'
 labels: 'type: feature request'
 body:
-  - type: markdown
-    attributes:
-      value: "Thanks for taking the time to fill out this form!"
-
-  - type: checkboxes
-    attributes:
-      label: "#"
-      description: "Please search [here](./?q=is%3Aissue) to see if an issue already exists for the feature you are requesting"
-      options:
-        - label: "I have searched the existing issues"
-          required: false
-
   - type: textarea
     validations:
       required: true
     attributes:
-      label: "Is your feature request related to a problem? Please describe it"
-      description: "A clear and concise description of what the problem is"
+      label: "Problem Statement"
+      description: "Describe the problem you're facing"
       placeholder: |
         I'm always frustrated when ...
 
   - type: textarea
     validations:
       required: true
     attributes:
-      label: "Describe the solution"
-      description: "Description of what you want to happen. Add any considered drawbacks"
-
-  - type: textarea
-    attributes:
-      label: "Teachability, documentation, adoption, migration strategy"
-      description: "Explain how users will be able to use this and possibly write out something for the docs. Maybe a screenshot or design?"
-
-  - type: textarea
-    validations:
-      required: true
-    attributes:
-      label: "What is the motivation / use case for changing the behavior?"
-      description: "Describe the motivation or the concrete use case"
+      label: "Feature Idea"
+      description: "Describe what you want instead. Examples are welcome!"

.github/ISSUE_TEMPLATE/model_request.yml

@@ -0,0 +1,21 @@
+name: "\U0001F929 Model Request"
+description: "Request a new model to be compiled"
+title: 'feat: [DESCRIPTION]'
+labels: 'type: model request'
+body:
+  - type: markdown
+    attributes:
+      value: "**Tip:** Download any HuggingFace model in app ([see guides](https://jan.ai/docs/models/manage-models#add-models)). Use this form for unsupported models only."
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: "Model Requests"
+      description: "If applicable, include the source URL, licenses, and any other relevant information"
+  - type: checkboxes
+    attributes:
+      label: "Which formats?"
+      options:
+        - label: GGUF (llama.cpp)
+        - label: TensorRT (TensorRT-LLM)
+        - label: ONNX (Onnx Runtime)

.github/workflows/jan-electron-build-nightly.yml

@@ -88,12 +88,12 @@ jobs:
         with:
           ref: ${{ needs.set-public-provider.outputs.ref }}
       - name: Download mac-x64 artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: latest-mac-x64
           path: ./latest-mac-x64
       - name: Download mac-arm artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: latest-mac-arm64
           path: ./latest-mac-arm64

.github/workflows/jan-electron-build.yml

@@ -79,12 +79,12 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Download mac-x64 artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: latest-mac-x64
           path: ./latest-mac-x64
       - name: Download mac-arm artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: latest-mac-arm64
           path: ./latest-mac-arm64

.github/workflows/jan-electron-linter-and-test.yml

@@ -37,6 +37,33 @@ on:
       - '!README.md'
 
 jobs:
+  base_branch_cov:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.base_ref }}
+      - name: Use Node.js v20.9.0
+        uses: actions/setup-node@v3
+        with:
+          node-version: v20.9.0
+
+      - name: Install dependencies
+        run: |
+          yarn
+          yarn build:core
+          yarn build:joi
+
+      - name: Run test coverage
+        run: yarn test:coverage
+
+      - name: Upload code coverage for ref branch
+        uses: actions/upload-artifact@v4
+        with:
+          name: ref-lcov.info
+          path: ./coverage/lcov.info
+
   test-on-macos:
     if: (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) || github.event_name == 'push' || github.event_name == 'workflow_dispatch'
     runs-on: [self-hosted, macOS, macos-desktop]
@@ -292,6 +319,56 @@ jobs:
           TURBO_TEAM: 'linux'
           TURBO_TOKEN: '${{ secrets.TURBO_TOKEN }}'
 
+  coverage-check:
+    runs-on: [self-hosted, Linux, ubuntu-desktop]
+    needs: base_branch_cov
+    if: (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) || github.event_name == 'push' || github.event_name == 'workflow_dispatch'
+    steps:
+      - name: Getting the repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Installing node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - name: 'Cleanup cache'
+        continue-on-error: true
+        run: |
+          rm -rf ~/jan
+          make clean
+
+      - name: Download code coverage report from base branch
+        uses: actions/download-artifact@v4
+        with:
+          name: ref-lcov.info
+
+      - name: Linter and test coverage
+        run: |
+          export DISPLAY=$(w -h | awk 'NR==1 {print $2}')
+          echo -e "Display ID: $DISPLAY"
+          npm config set registry ${{ secrets.NPM_PROXY }} --global
+          yarn config set registry ${{ secrets.NPM_PROXY }} --global
+          make lint
+          yarn build:test
+          yarn test:coverage
+        env:
+          TURBO_API: '${{ secrets.TURBO_API }}'
+          TURBO_TEAM: 'linux'
+          TURBO_TOKEN: '${{ secrets.TURBO_TOKEN }}'
+
+      - name: Generate Code Coverage report
+        id: code-coverage
+        uses: barecheck/code-coverage-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          lcov-file: './coverage/lcov.info'
+          base-lcov-file: './lcov.info'
+          send-summary-comment: true
+          show-annotations: 'warning'
+
   test-on-ubuntu-pr-target:
     runs-on: [self-hosted, Linux, ubuntu-desktop]
     if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository

.github/workflows/nightly-integrate-cortex-cpp.yml

@@ -51,13 +51,13 @@ jobs:
         latest_prerelease_asset_count=$(get_asset_count "$latest_prerelease_name")
 
         if [ "$current_version_name" = "$latest_prerelease_name" ]; then
-          echo "cortex cpp remote repo doesn't have update today, skip update cortex-cpp for today nightly build"
+          echo "cortex cpp remote repo doesn't have update today, skip update cortex.cpp for today nightly build"
           echo "::set-output name=pr_created::false"
           exit 0
         fi
 
         if [ "$current_version_asset_count" != "$latest_prerelease_asset_count" ]; then
-          echo "Latest prerelease version has different number of assets, somethink went wrong, skip update cortex-cpp for today nightly build"
+          echo "Latest prerelease version has different number of assets, somethink went wrong, skip update cortex.cpp for today nightly build"
           echo "::set-output name=pr_created::false"
           exit 1
         fi