Merge pull request #171 from janhq/feature/add-tar-gz-to-release

Add tar gz to nitro release and add docs publish instruction to README.md docs
janhq · Nov 22, 2023 · 0c4d46d · 0c4d46d
2 parents 763b3a3 + 73441c0
commit 0c4d46d
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 3 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -74,6 +74,7 @@ jobs:
           mkdir -p nitro
           cp build/nitro nitro/
           zip -r nitro.zip nitro
+          tar -czvf nitro.tar.gz nitro
           # run e2e testing
           cd nitro
           chmod +x ../.github/scripts/e2e-test-linux-and-mac.sh && ../.github/scripts/e2e-test-linux-and-mac.sh ./nitro ${{ env.MODEL_URL }}
@@ -88,6 +89,16 @@ jobs:
           asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-linux-amd64.zip
           asset_content_type: application/zip
 
+      - uses: actions/[email protected]
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create-draft-release.outputs.upload_url }}
+          asset_path: ./nitro.tar.gz
+          asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-linux-amd64.tar.gz
+          asset_content_type: application/gzip
+
   ubuntu-amd64-cuda-build:
     runs-on: linux-gpu
     needs: create-draft-release
@@ -122,7 +133,7 @@ jobs:
           mkdir -p nitro
           cp build/nitro nitro/
           zip -r nitro.zip nitro
-          
+          tar -czvf nitro.tar.gz nitro
           # run e2e testing
           cd nitro
           chmod +x ../.github/scripts/e2e-test-linux-and-mac.sh && ../.github/scripts/e2e-test-linux-and-mac.sh ./nitro ${{ env.MODEL_URL }}
@@ -137,6 +148,16 @@ jobs:
           asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-linux-amd64-cuda.zip
           asset_content_type: application/zip
 
+      - uses: actions/[email protected]
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create-draft-release.outputs.upload_url }}
+          asset_path: ./nitro.tar.gz
+          asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-linux-amd64-cuda.tar.gz
+          asset_content_type: application/gzip
+
   macOS-M-build:
     runs-on: mac-silicon
     needs: create-draft-release
@@ -173,7 +194,7 @@ jobs:
           cp llama.cpp/ggml-metal.metal nitro/
           cp build/nitro nitro/
           zip -r nitro.zip nitro
-          
+          tar -czvf nitro.tar.gz nitro
           # run e2e testing
           cd nitro
           chmod +x ../.github/scripts/e2e-test-linux-and-mac.sh && ../.github/scripts/e2e-test-linux-and-mac.sh ./nitro ${{ env.MODEL_URL }}
@@ -188,6 +209,16 @@ jobs:
           asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-mac-arm64.zip
           asset_content_type: application/zip
 
+      - uses: actions/[email protected]
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create-draft-release.outputs.upload_url }}
+          asset_path: ./nitro.tar.gz
+          asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-mac-arm64.tar.gz
+          asset_content_type: application/gzip
+
   macOS-Intel-build:
     runs-on: macos-latest
     needs: create-draft-release
@@ -222,7 +253,7 @@ jobs:
           mkdir -p nitro
           cp build/nitro nitro/
           zip -r nitro.zip nitro
-          
+          tar -czvf nitro.tar.gz nitro
           # run e2e testing
           cd nitro
           chmod +x ../.github/scripts/e2e-test-linux-and-mac.sh && ../.github/scripts/e2e-test-linux-and-mac.sh ./nitro ${{ env.MODEL_URL }}
@@ -236,6 +267,15 @@ jobs:
           asset_path: ./nitro.zip
           asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-mac-amd64.zip
           asset_content_type: application/zip
+      - uses: actions/[email protected]
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create-draft-release.outputs.upload_url }}
+          asset_path: ./nitro.tar.gz
+          asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-mac-amd64.tar.gz
+          asset_content_type: application/gzip
 
   windows-amd64-build:
     runs-on: windows-latest
@@ -293,6 +333,8 @@ jobs:
           robocopy build_deps\_install\bin .\build\Release zlib.dll
           robocopy build\bin\Release .\build\Release llama.dll
           7z a nitro.zip .\build\Release\*
+          7z a -ttar temp.tar .\build\Release\*
+          7z a -tgzip nitro.tar.gz temp.tar
           cd .\build\Release
           ..\..\.github\scripts\e2e-test-windows.bat .\nitro.exe ${{ env.MODEL_URL }}
 
@@ -305,6 +347,17 @@ jobs:
           asset_path: ./nitro.zip
           asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-win-amd64.zip
           asset_content_type: application/zip
+
+
+      - uses: actions/[email protected]
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create-draft-release.outputs.upload_url }}
+          asset_path: ./nitro.tar.gz
+          asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-win-amd64.tar.gz
+          asset_content_type: application/gzip
 
   windows-amd64-cuda-build:
     runs-on: windows-nvidia
@@ -352,6 +405,8 @@ jobs:
           robocopy build_deps\_install\bin .\build\Release zlib.dll
           robocopy build\bin\Release .\build\Release llama.dll
           7z a nitro.zip .\build\Release\*
+          7z a -ttar temp.tar .\build\Release\*
+          7z a -tgzip nitro.tar.gz temp.tar
           cd .\build\Release
           ..\..\.github\scripts\e2e-test-windows.bat .\nitro.exe ${{ env.MODEL_URL }}
 
@@ -364,6 +419,15 @@ jobs:
           asset_path: ./nitro.zip
           asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-win-amd64-cuda.zip
           asset_content_type: application/zip        
+      - uses: actions/[email protected]
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create-draft-release.outputs.upload_url }}
+          asset_path: ./nitro.tar.gz
+          asset_name: nitro-${{ needs.create-draft-release.outputs.version }}-win-amd64-cuda.tar.gz
+          asset_content_type: application/gzip     
 
   update_release_draft:
     needs: [ubuntu-amd64-build, ubuntu-amd64-cuda-build, macOS-M-build, macOS-Intel-build, windows-amd64-build, windows-amd64-cuda-build]

diff --git a/docs/README.md b/docs/README.md
@@ -40,6 +40,12 @@ $ GIT_USER=<Your GitHub username> yarn deploy
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
 
+### Preview URL, Pre-release and Publishing Documentation
+
+When a PR is created, the preview URL will be automatically commented on the PR. For staging or pre-release documentation, use the following domains [https://pre-release-nitro.jan.ai/](https://pre-release-nitro.jan.ai/)
+
+To officially publish documentation, create a tag in the format `vx.y.z-docs` (e.g., `v0.1.1-docs`) on the `main` branch. The documentation will then be published to [https://nitro.jan.ai/](https://nitro.jan.ai/)
+
 ### Additional Plugins
 - @docusaurus/theme-live-codeblock
 - [Redocusaurus](https://redocusaurus.vercel.app/): manually upload swagger files at `/openapi/OpenAPISpec.json`