chore: publishing initium-cli as an NPM package (#99)

Co-authored-by: Luca Lanziani <[email protected]>

.github/workflows/onbranch.yaml

@@ -1,9 +1,9 @@
 name: Build on branch
 
 on:
- push:
-   branches-ignore:
-     - "main"
+  push:
+    branches-ignore:
+      - "main"
 
 jobs:
   cli:
@@ -23,4 +23,4 @@ jobs:
         env:
           INITIUM_APP_NAME: initium-cli
           INITIUM_REGISTRY_USER: ${{ github.actor }}
-          INITIUM_REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
+          INITIUM_REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/onmain.yaml

@@ -1,6 +1,6 @@
 name: Deploy on main
 
-on: 
+on:
   push:
     branches:
       - main
@@ -21,4 +21,4 @@ jobs:
         env:
           INITIUM_APP_NAME: initium-cli
           INITIUM_REGISTRY_USER: ${{ github.actor }}
-          INITIUM_REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
+          INITIUM_REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-please.yaml

@@ -21,8 +21,34 @@ jobs:
           private_key: ${{ secrets.RELEASE_PLEASE_APP_PRIVATE_KEY }}
 
       - uses: google-github-actions/release-please-action@v3
+        id: release_please
         with:
           release-type: go
           token: ${{ steps.get_installation_token.outputs.token }}
           bump-minor-pre-major: true
           package-name: release-please-action
+          extra-files: |
+            npm/package.json
+
+      - name: Get commit author
+        id: commit_author
+        run: |
+          author=$(gh pr list --search ${{ github.sha }} --state merged --json mergedBy --jq '.[0].mergedBy.login'
+          echo "author=${author}" >> $$GITHUB_OUTPUT
+        env:
+          GITHUB_TOKEN: ${{ steps.get_installation_token.outputs.token }}
+
+      - uses: actions/setup-node@v3
+        # This sets up the .npmrc file for publishing to npm
+        with:
+          node-version: "18.x"
+          registry-url: "https://registry.npmjs.org"
+
+      # we want the good pipefail behaviour https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell
+      - shell: bash
+        run: |
+          cd npm
+          ./publish.sh
+        env:
+          NPM_TOKEN: ${{ secrets[format('NPM_TOKEN_{0}', steps.commit_author.outputs.author)] || secrets.NPM_TOKEN }}
+          OPTIC_TOKEN: ${{ secrets[format('OPTIC_TOKEN_{0}', steps.commit_author.outputs.author)] || secrets.OPTIC_TOKEN }}

.github/workflows/release.yml

@@ -4,7 +4,7 @@ on:
   push:
     # run only against tags
     tags:
-      - '*'
+      - "*"
 
 permissions:
   contents: write

.gitignore

@@ -6,3 +6,5 @@ Dockerfile.initium
 initium_onmain.yaml
 initium_onbranch.yaml
 dist/
+
+node_modules

README.md

@@ -4,6 +4,18 @@ A single static binary that can run on any CI to build your code and deploy it i
 
 All with a nice development workflow in mind like ephemeral environment for your PRs.
 
+### Running the CLI
+
+The CLI is currently published on [NPM](https://www.npmjs.com/package/initium). You can run it using
+
+```
+npx initium
+```
+
+That will install the Initium CLI in your folder's `node_modules`.
+
+We recommend you not to try installing the CLI globally if you don't use a Node.js version manager (like `nvm`), as you can run into permission errors.
+
 ### Pre-requisites
 
 1. GoLang

npm/.npmignore

@@ -0,0 +1 @@
+publish.sh

npm/README.md

@@ -0,0 +1,7 @@
+# Publish the initium CLI on NPM
+
+This folder is here to generate an npm package that will allow user to run initium with either npm or npx.
+
+NOTE: This package doesn't contain the binaries.
+
+You can check the code in the `script` folder to see how this package will detect the platform and architecture of your machine and download the relevant binary from the github releases of this repo.