Skip to content

Commit

Permalink
Add document for nightly build and update message for manual build
Browse files Browse the repository at this point in the history
  • Loading branch information
hientominh committed Dec 4, 2023
1 parent c4fab6d commit 2d00415
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 16 deletions.
17 changes: 15 additions & 2 deletions .github/workflows/jan-electron-build-nightly.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Jan Build Electron App Nightly
name: Jan Build Electron App Nightly or Manual

on:
schedule:
Expand Down Expand Up @@ -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
Expand All @@ -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 }}
38 changes: 24 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 2d00415

Please sign in to comment.