fix: add ability to run install command to update locks

Author: fbritoferreira

README.md

@@ -48,14 +48,16 @@ GLOBAL_AGENT_NO_PROXY    # Like above but for no proxied requests
 
 GITLAB_HOST # optional, if you're using custom GitLab host, will fallback to `CI_SERVER_URL` if not provided
 
-GITLAB_TOKEN                 # required, token with accessibility to push
-GITLAB_TOKEN_TYPE            # optional, type of the provided token in GITLAB_TOKEN. defaults to personal access token. can be `job` if you provide the Gitlab CI_JOB_TOKEN or `oauth` if you use Gitlab Oauth token
-GITLAB_CI_USER_NAME          # optional, username with accessibility to push, used in pairs of the above token (if it was personal access token). If not set read it from the Gitlab API
-GITLAB_CI_USER_EMAIL         # optional, default `gitlab[bot]@users.noreply.gitlab.com`
-GITLAB_COMMENT_TYPE          # optional, type of the comment. defaults to `discussion`. can be set to `note` to not create a discussion instead of a thread
-GITLAB_ADD_CHANGESET_MESSAGE # optional, default commit message for adding changesets on GitLab Web UI
-DEBUG_GITLAB_CREDENTIAL      # optional, default `false`
-GITLAB_COMMENT_CUSTOM_LINKS  # optional, allow the linkS for the absent comment to be overwritten
+GITLAB_TOKEN                  # required, token with accessibility to push
+GITLAB_TOKEN_TYPE             # optional, type of the provided token in GITLAB_TOKEN. defaults to personal access token. can be `job` if you provide the Gitlab CI_JOB_TOKEN or `oauth` if you use Gitlab Oauth token
+GITLAB_CI_USER_NAME           # optional, username with accessibility to push, used in pairs of the above token (if it was personal access token). If not set read it from the Gitlab API
+GITLAB_CI_USER_EMAIL          # optional, default `gitlab[bot]@users.noreply.gitlab.com`
+GITLAB_COMMENT_TYPE           # optional, type of the comment. defaults to `discussion`. can be set to `note` to not create a discussion instead of a thread
+GITLAB_ADD_CHANGESET_MESSAGE  # optional, default commit message for adding changesets on GitLab Web UI
+DEBUG_GITLAB_CREDENTIAL       # optional, default `false`
+GITLAB_COMMENT_CUSTOM_LINKS   # optional, allow the linkS for the absent comment to be overwritten
+UPDATE_PACKAGE_LOCK_BEFORE_MR # optional, default `false`
+UPDATE_PACKAGE_LOCK_SCRIPT    # optional, default `npm install`
 ```
 
 ### Example workflow

src/env.ts

@@ -21,6 +21,10 @@ export const env = {
   DEBUG_GITLAB_CREDENTIAL: process.env.DEBUG_GITLAB_CREDENTIAL ?? 'false',
   GITLAB_COMMENT_CUSTOM_LINKS:
     process.env.GITLAB_COMMENT_CUSTOM_LINKS ?? 'false',
+  UPDATE_PACKAGE_LOCK_BEFORE_MR:
+    process.env.UPDATE_PACKAGE_LOCK_BEFORE_MR ?? 'false',
+  UPDATE_PACKAGE_LOCK_SCRIPT:
+    process.env.UPDATE_PACKAGE_LOCK_BEFORE_MR ?? 'npm install',
 
   // only check for the token if we are explicitly using it
   // eslint-disable-next-line sonar/function-name

src/run.ts

@@ -10,6 +10,7 @@ import resolveFrom from 'resolve-from'
 import semver from 'semver'
 
 import * as context from './context.js'
+import { env } from './env.js'
 import * as gitUtils from './gitUtils.js'
 import readChangesetState from './readChangesetState.js'
 import {
@@ -290,6 +291,12 @@ ${
     await gitUtils.commitAll(finalCommitMessage)
   }
 
+  // Allow user to update their lockfiles before mr is created
+  if (env.UPDATE_PACKAGE_LOCK_BEFORE_MR === 'true') {
+    const script = env.UPDATE_PACKAGE_LOCK_SCRIPT
+    await exec(script)
+  }
+
   await gitUtils.push(versionBranch, { force: true })
 
   const searchResult = await api.MergeRequests.all({

src/types.ts

@@ -23,6 +23,8 @@ export type Env = GitLabCIPredefinedVariables &
     GITLAB_ADD_CHANGESET_MESSAGE?: string
     DEBUG_GITLAB_CREDENTIAL: LooseString<'1' | 'true'>
     GITLAB_COMMENT_CUSTOM_LINKS: string
+    UPDATE_PACKAGE_LOCK_BEFORE_MR: LooseString<'false' | 'true'>
+    UPDATE_PACKAGE_LOCK_SCRIPT: string
 
     HOME: string
     NPM_TOKEN?: string