feat: asyncapi release for alpine distros (#1834)

Co-authored-by: utnim2 <mintugogoi567@gmail.com>
Co-authored-by: asyncapi-bot <info@asyncapi.io>

Author: Gmin2

.changeset/1834.md

@@ -0,0 +1,10 @@
+---
+'@asyncapi/cli': minor
+---
+
+feat: asyncapi release for alpine distros
+
+- 54ba750: feat: asyncapi on alpine distros
+- 44d72c3: fix: rename the scripts to use rename instead of tarballs
+
+

.github/workflows/upload-release-assets.yml

@@ -21,6 +21,12 @@ jobs:
             npm_script: pack:tarballs
             dist_folder: tar
             extension: tar.gz
+          - os: ubuntu-latest
+            npm_script: pack:tarballs:alpine
+            dist_folder: tar
+            extension: alpine.tar.gz
+            container: 'node:20-alpine'
+            alpine: true
           - os: ubuntu-latest
             npm_script: pack:windows
             dist_folder: win32
@@ -37,21 +43,34 @@ jobs:
             npm_script: pack:macos
             dist_folder: macos
             extension: x64.pkg
+    
+    container: ${{ matrix.container }}
+    
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+      
       - name: Check package-lock version
         uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master
         id: lockversion
+      
       - name: Setup Node.js
+        if: matrix.container == ''
         uses: actions/setup-node@v4
         with:
           node-version: "${{ steps.lockversion.outputs.version }}"
+      
+      - name: Install dependencies in Alpine
+        if: matrix.container == 'node:20-alpine'
+        run: |
+          apk add --no-cache git python3 make g++
+      
       - if: matrix.npm_script == 'pack:windows'
         name: install nodejs for windows
         uses: actions/setup-node@v4
         with:
           node-version: 20
+      
       - name: Get version from package.json
         uses: actions/github-script@v6
         id: extractver
@@ -77,7 +96,14 @@ jobs:
         run: npm run prepublishOnly
       - name: Assets generation
         shell: bash
-        run: npm run ${{ matrix.npm_script }}
+        run: |
+          npm run ${{ matrix.npm_script }}
+          if [[ "${{ matrix.alpine }}" == "true" ]]; then
+            npm run pack:rename alpine
+          else
+            npm run pack:rename
+          fi
+      
       - name: Update release
         uses: softprops/action-gh-release@v1
         with:
@@ -92,4 +118,4 @@ jobs:
           fields: repo,action,workflow
           text: 'AsyncAPI CLI release build artifacts failed'
         env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}

docs/installation.md

@@ -162,7 +162,27 @@ curl -OL https://github.com/asyncapi/cli/releases/download/<replace this with th
 ```
 
 ### Other distros
-You can install the AsyncAPI CLI for other Linux distros using the archive `tar.gz` file. To download the latest release of the CLI, run this command in your terminal:
+You can install the AsyncAPI CLI for other Linux distros using the archive `tar.gz` file. 
+
+#### For Alpine Linux / musl-based systems:
+To download the latest Alpine-compatible release, run this command in your terminal:
+```sh
+curl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi-alpine.tar.gz
+```
+
+To download a specific Alpine-compatible release, run this command in your terminal:
+```sh
+curl -OL https://github.com/asyncapi/cli/releases/download/<replace this with the specific CLI version e.g v0.13.0>/asyncapi-alpine.tar.gz
+```
+
+Once downloaded, untar the file:
+```sh
+tar -xzf asyncapi-alpine.tar.gz
+```
+
+#### For other Linux distributions (glibc-based):
+
+To download the latest release of the CLI, run this command in your terminal:
 ```sh
 curl -OL https://github.com/asyncapi/cli/releases/latest/download/asyncapi.tar.gz
 ```
@@ -177,6 +197,8 @@ Once you have downloaded the archived file, untar it by running this command in
 tar -xzf asyncapi.tar.gz
 ```
 
+### Setting up the symlink (for both Alpine and glibc versions):
+
 The step above will create an `AsyncAPI` directory in the current path. To run the CLI from anywhere, you must create a `symlink`. If the current path you are on is `/user/local/bin`, for example, you must create the `symlink` in the `/user/local/bin` directory by following these steps:
 ```sh
 # cd into the unarchived directory
@@ -191,3 +213,5 @@ ln -s <absolute-path>/bin/asyncapi /user/local/bin/asyncapi
 # The "asyncapi" command should be available to be used
 asyncapi
 ```
+> [!NOTE]
+> If youare using Alpine Linux or any musl-based distribution, make sure to download the `-alpine.tar.gz` version to avoid glibc compatibility issues. The regular `asyncapi.tar.gz` file is compiled for glibc-based systems and will not work on Alpine.

package.json

@@ -172,6 +172,7 @@
     "pack:macos": "oclif pack macos && npm run pack:rename",
     "pack:linux": "oclif pack deb && npm run pack:rename",
     "pack:tarballs": "oclif pack tarballs -t linux-x64 && npm run pack:rename",
+    "pack:tarballs:alpine": "oclif pack tarballs -t linux-x64 && npm run pack:rename alpine",
     "pack:windows": "oclif pack win && npm run pack:rename",
     "pack:rename": "node scripts/releasePackagesRename.js",
     "prepublishOnly": "npm run build",

scripts/releasePackagesRename.js

@@ -37,15 +37,17 @@ async function renameDeb({version, name, sha}) {
   await checkAndRenameFile(generatedPath, newPath);
 }
 
-async function renameTar({version, name, sha}) {
+async function renameTar({version, name, sha, isAlpine}) {
   const dist = 'dist';
 
   const generatedPath = path.resolve(dist, `${name}-v${version}-${sha}-linux-x64.tar.gz`);
   // for tarballs, the files are generated in `dist/` directory.
   // Creates a new `tar` directory(`dist/tar`), and moves the generated tarball inside that directory.
   const tarDirectory = path.resolve(dist, 'tar');
   await createDirectory(tarDirectory);
-  const newPath = path.resolve(tarDirectory, 'asyncapi.tar.gz');
+
+  const fileName = isAlpine ? 'asyncapi-alpine.tar.gz' : 'asyncapi.tar.gz';
+  const newPath = path.resolve(tarDirectory, fileName);
   await checkAndRenameFile(generatedPath, newPath);
 }
 
@@ -69,12 +71,18 @@ async function renamePackages() {
   const version = packageJson.version;
   const name = 'asyncapi';
   const sha = await git.revparse(['--short', 'HEAD']);
-  await renameDeb({version: version.split('-')[0], name, sha});
-  await renamePkg({version, name, sha, arch: 'x64'});
-  await renamePkg({version, name, sha, arch: 'arm64'});
-  await renameWindows({version, name, sha, arch: 'x64'});
-  await renameWindows({version, name, sha, arch: 'x86'});
-  await renameTar({version, name, sha});
+  const isAlpine = process.argv.includes('alpine');
+
+  if (isAlpine) {
+    await renameTar({version, name, sha, isAlpine: true});
+  } else {
+    await renameDeb({version: version.split('-')[0], name, sha});
+    await renamePkg({version, name, sha, arch: 'x64'});
+    await renamePkg({version, name, sha, arch: 'arm64'});
+    await renameWindows({version, name, sha, arch: 'x64'});
+    await renameWindows({version, name, sha, arch: 'x86'});
+    await renameTar({version, name, sha, isAlpine: false});
+  }
 }
 
 renamePackages();