fix(release): Support path offset from git root to Nx workspace

[gionkunz]

@JamesHenry @AgentEnder

Current Behavior

Currently Nx Release does not support the use-case where the Nx Workspace is within a nested folder under the Git root directory. As it's quite common to have a backend,infra,frontend separation on the repo top directory and then only initialize the Nx Workspace in the frontend directory, this is probably needed in many projects.

Also, see issue #27995

Expected Behavior

The version and changelog commands both should support workspaces that are nested within sub-folders of a Git repository.

Related Issue(s)

Fixes #27995

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
nx-dev	✅ Ready (Inspect)	Visit Preview	Nov 7, 2024 10:29am

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit eb5bca1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 4 targets

• nx affected --targets=lint,test,build,e2e,e2e-ci --base=6a3d864ba1adb935ad2b3248a9cf0a44fa8b8f5c --head=eb5bca1b2c76cc3f7e0cb5d122be5a0c3e1de393 --parallel=3
• nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte
• nx-cloud record -- nx format:check --base=6a3d864ba1adb935ad2b3248a9cf0a44fa8b8f5c --head=eb5bca1b2c76cc3f7e0cb5d122be5a0c3e1de393
• nx documentation --no-dte

---

Sent with 💌 from NxCloud.

[gionkunz]

Hi @xiongemi @leosvelperez. Do you need anything else for the review of this PR? Please let me know if I need to add anything. We are currently relying on a custom monkey patch using patch-package to make it work in our environment.

[m3Lith]

This is a bit of a blocker for us too, would love to see it released..

[JamesHenry]

Thanks a lot for this @gionkunz and I'm sorry for the delay in getting back to you. I think we can avoid a lot of the changes here by acknowledging that the git absolute root and its offset are basically as constant as the workspaceRoot itself.

Therefore, in git.ts I would simply do that following:

// ...
// ... existing parseGitCommit() function here (with the one tweak to leverage replaceGitRootPathDiff() in the reduce as you have already)
// ...

/**
 * Lazily compute the offset from the workspace root to the git root, if any, one time,
 * it is not something that changes during the execution of a command.
 */
let workspaceGitRootOffset: string;

function replaceGitRootPathDiff(file: string) {
  if (!workspaceGitRootOffset) {
    let absoluteGitRoot: string;
    // This check is probably debatable, we could probably just always run the getAbsoluteGitRoot tbf...
    if (existsSync(join(workspaceRoot, '.git'))) {
      absoluteGitRoot = workspaceRoot;
    } else {
      absoluteGitRoot = getAbsoluteGitRoot();
    }
    workspaceGitRootOffset = getWorkspaceGitRootOffset(
      absoluteGitRoot,
      workspaceRoot
    );
  }

  if (
    !workspaceGitRootOffset ||
    !file.startsWith(workspaceGitRootOffset)
  ) {
    return file;
  }

  return file.replace(workspaceGitRootOffset, '');
}

// (no need to export this util any more)
function getAbsoluteGitRoot() {
  try {
    return execSync('git', ['rev-parse', '--show-toplevel']).trim();
  } catch (e) {
    throw new Error(`Could not determine git root`);
  }
}

With your getWorkspaceGitRootOffset() function and unit tests remaining the same.

I think that gets us everything we need without changing any other files or function signatures right?

[JamesHenry]

Hi again @gionkunz I am going to close this one in favour of #28650 which solves the problem via a more direct mechanism - namely, the --relative flag on the git command.

[gionkunz]

@JamesHenry Even better! Thanks!

[github-actions]

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.