From 2d004155ea583e19a3975f09f2d624cfc16a9da0 Mon Sep 17 00:00:00 2001
From: Hien To <tominhhien97@gmail.com>
Date: Mon, 4 Dec 2023 14:01:04 +0700
Subject: [PATCH] Add document for nightly build and update message for manual
 build

---
 .../workflows/jan-electron-build-nightly.yml  | 17 ++++++++-
 README.md                                     | 38 ++++++++++++-------
 2 files changed, 39 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/jan-electron-build-nightly.yml b/.github/workflows/jan-electron-build-nightly.yml
index 1a34fee4dc..d0c2adb0c3 100644
--- a/.github/workflows/jan-electron-build-nightly.yml
+++ b/.github/workflows/jan-electron-build-nightly.yml
@@ -1,4 +1,4 @@
-name: Jan Build Electron App Nightly
+name: Jan Build Electron App Nightly or Manual
 
 on:
   schedule:
@@ -173,8 +173,9 @@ jobs:
           name: jan-linux-amd64-${{ steps.version_update.outputs.new_version }}.deb
           path: ./electron/dist/*.deb
 
-  noti-discord:
+  noti-discord-nightly:
     needs: [build-macos, build-windows-x64, build-linux-x64]
+    if: github.event_name == 'schedule'
     runs-on: ubuntu-latest
     steps:
       - name: Notify Discord
@@ -183,3 +184,15 @@ jobs:
           args: "Nightly build artifact: https://github.com/janhq/jan/actions/runs/{{ GITHUB_RUN_ID }}"
         env:
           DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+
+  noti-discord-manual:
+    needs: [build-macos, build-windows-x64, build-linux-x64]
+    if: github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Notify Discord
+        uses: Ilshidur/action-discord@master
+        with:
+          args: "Manual build artifact: https://github.com/janhq/jan/actions/runs/{{ GITHUB_RUN_ID }}"
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
diff --git a/README.md b/README.md
index 7a1daacdd1..9c686c4c2f 100644
--- a/README.md
+++ b/README.md
@@ -55,23 +55,17 @@ As Jan is development mode, you might get stuck on a broken build.
 
 To reset your installation:
 
-1. Delete Jan from your `/Applications` folder
+1. **Remove Jan from your Applications folder and Cache folder**
 
-1. Delete Application data:
-   ```sh
-   # Newer versions
-   rm -rf /Users/$(whoami)/Library/Application\ Support/jan
-
-   # Versions 0.2.0 and older
-   rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron
-   ```
-   
-1. Clear Application cache:
-   ```sh
-   rm -rf /Users/$(whoami)/Library/Caches/jan*
+   ```bash
+   make clean
    ```
 
-1. Use the following commands to remove any dangling backend processes:
+   This will remove all build artifacts and cached files:
+   - Delete Jan from your `/Applications` folder
+   - Clear Application cache in `/Users/$(whoami)/Library/Caches/jan`
+
+2. Use the following commands to remove any dangling backend processes:
 
     ```sh
     ps aux | grep nitro
@@ -124,6 +118,22 @@ make build
 
 This will build the app MacOS m1/m2 for production (with code signing already done) and put the result in `dist` folder.
 
+## Nightly Build
+
+Nightly build is a process where the software is built automatically every night. This helps in detecting and fixing bugs early in the development cycle. The process for this project is defined in [`.github/workflows/jan-electron-build-nightly.yml`](.github/workflows/jan-electron-build-nightly.yml)
+
+You can join our Discord server [here](https://discord.gg/FTk2MvZwJH) and go to channel [github-jan](https://discordapp.com/channels/1107178041848909847/1148534730359308298) to monitor the build process.
+
+The nightly build is triggered at 2:00 AM UTC every day.
+
+The nightly build can be downloaded from the url notified in the Discord channel. Please access the url from the browser and download the build artifacts from there.
+
+## Manual Build
+
+Manual build is a process where the software is built manually by the developers. This is usually done when a new feature is implemented or a bug is fixed. The process for this project is defined in [`.github/workflows/jan-electron-build-nightly.yml`](.github/workflows/jan-electron-build-nightly.yml)
+
+It is similar to the nightly build process, except that it is triggered manually by the developers.
+
 ## Acknowledgements
 
 Jan builds on top of other open-source projects: