Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Commit 90756ea

Browse files
authored
Add document for nightly build and update message for manual build (#232)
Co-authored-by: Hien To <tominhhien97@gmail.com>
1 parent 78e15a4 commit 90756ea

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

.github/workflows/build.yml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -445,14 +445,26 @@ jobs:
445445
env:
446446
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
447447

448-
noti-discord:
449-
if: always() && (github.event_name == 'schedule' || github.event_name == 'workflow_dispatch') && (needs.create-draft-release.result == 'success' || needs.create-draft-release.result == 'skipped') && needs.ubuntu-amd64-build.result == 'success' && needs.ubuntu-amd64-cuda-build.result == 'success' && needs.macOS-M-build.result == 'success' && needs.macOS-Intel-build.result == 'success' && needs.windows-amd64-build.result == 'success' && needs.windows-amd64-cuda-build.result == 'success'
448+
noti-discord-nightly:
449+
if: always() && github.event_name == 'schedule' && (needs.create-draft-release.result == 'success' || needs.create-draft-release.result == 'skipped') && needs.ubuntu-amd64-build.result == 'success' && needs.ubuntu-amd64-cuda-build.result == 'success' && needs.macOS-M-build.result == 'success' && needs.macOS-Intel-build.result == 'success' && needs.windows-amd64-build.result == 'success' && needs.windows-amd64-cuda-build.result == 'success'
450450
needs: [create-draft-release, ubuntu-amd64-build, ubuntu-amd64-cuda-build, macOS-M-build, macOS-Intel-build, windows-amd64-build, windows-amd64-cuda-build]
451451
runs-on: ubuntu-latest
452452
steps:
453453
- name: Notify Discord
454454
uses: Ilshidur/action-discord@master
455455
with:
456456
args: "Nightly build artifact: https://github.com/janhq/nitro/actions/runs/{{ GITHUB_RUN_ID }}"
457+
env:
458+
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
459+
460+
noti-discord-manual:
461+
if: always() && github.event_name == 'workflow_dispatch' && (needs.create-draft-release.result == 'success' || needs.create-draft-release.result == 'skipped') && needs.ubuntu-amd64-build.result == 'success' && needs.ubuntu-amd64-cuda-build.result == 'success' && needs.macOS-M-build.result == 'success' && needs.macOS-Intel-build.result == 'success' && needs.windows-amd64-build.result == 'success' && needs.windows-amd64-cuda-build.result == 'success'
462+
needs: [create-draft-release, ubuntu-amd64-build, ubuntu-amd64-cuda-build, macOS-M-build, macOS-Intel-build, windows-amd64-build, windows-amd64-cuda-build]
463+
runs-on: ubuntu-latest
464+
steps:
465+
- name: Notify Discord
466+
uses: Ilshidur/action-discord@master
467+
with:
468+
args: "Manual build artifact: https://github.com/janhq/nitro/actions/runs/{{ GITHUB_RUN_ID }}"
457469
env:
458470
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,22 @@ Nitro server is compatible with the OpenAI format, so you can expect the same ou
122122
## Compile from source
123123
To compile nitro please visit [Compile from source](docs/new/build-source.md)
124124

125+
## Nightly Build
126+
127+
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/build.yml`](.github/workflows/build.yml)
128+
129+
You can join our Discord server [here](https://discord.gg/FTk2MvZwJH) and go to channel [github-nitro](https://discordapp.com/channels/1107178041848909847/1151022176019939328) to monitor the build process.
130+
131+
The nightly build is triggered at 2:00 AM UTC every day.
132+
133+
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.
134+
135+
## Manual Build
136+
137+
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/build.yml`](.github/workflows/build.yml)
138+
139+
It is similar to the nightly build process, except that it is triggered manually by the developers.
140+
125141
### Contact
126142

127143
- For support, please file a GitHub ticket.

0 commit comments

Comments
 (0)