fix: updates based on review comments

finos · Mar 26, 2024 · 06a62d0 · 06a62d0
1 parent 4db5f81
commit 06a62d0
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 6 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -21,9 +21,9 @@ jobs:
           fetch-depth: 0
 
       - name: Install Dependencies
-        run: npm i
+        run: npm install --workspaces
 
       - name: Code Linting
         run: |
           npm run lint
-          npm run lint --workspaces
+          npm run lint --workspaces --if-present
diff --git a/packages/git-proxy-cli/index.js b/packages/git-proxy-cli/index.js
@@ -15,8 +15,8 @@ axios.defaults.timeout = 30000;
 
 /**
  * Log in to Git Proxy
- * @param {*} username The user name to login with
- * @param {*} password The password to use for the login
+ * @param {string} username The user name to login with
+ * @param {string} password The password to use for the login
  */
 async function login(username, password) {
   try {
@@ -56,7 +56,7 @@ async function login(username, password) {
 
 /**
  * Approve commit by ID
- * @param {*} commitId The ID of the commit to approve
+ * @param {string} commitId The ID of the commit to approve
  */
 async function approveCommit(commitId) {
   if (!fs.existsSync(GIT_PROXY_COOKIE_FILE)) {

diff --git a/website/docs/installation.mdx b/website/docs/installation.mdx
@@ -7,7 +7,6 @@ description: How to install Git Proxy in your environment
 
 To install Git Proxy, you must first install [Node.js](https://nodejs.org/en/download). Then, use the [npm package manager](https://www.npmjs.com/):
 
-To install Git Proxy
 ```bash
 npm install -g @finos/git-proxy
 ```