conventional-changelog/commitlint

Error when working from within a branch worktree

Open

#787 opened on Sep 13, 2019

View on GitHub
 (13 comments) (0 reactions) (0 assignees)TypeScript (15,497 stars) (896 forks)batch import
bughelp wanted

Description

When trying to run commitlint from within a branch worktree directory, I get the following error: could not find git root from undefined

Expected Behavior

The operation should succeed without error.

Current Behavior

The operation errors with could not find git root from undefined

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Steps to Reproduce (for bugs)

  1. Checkout a repo
  2. Checkout a different branch into a separate folder via worktree: git worktree add -b my-branch ../my-branch
  3. CD into the branch folder
  4. Make some changers
  5. Try to commit

Your Environment

Executable Version
commitlint --version 8.1.0
git --version git version 2.20.1.windows.1
node --version v10.14.1

Contributor guide

Tech stack
typescript
Domain
cli
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
git worktree conceptcommitlint internalsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how commitlint resolves the git root. The error suggests that the git root detection returns undefined in worktree directories. Check the source code in the CLI package, likely in the `@commitlint/cli` or `@commitlint/load` module, where `git rev parse show toplevel` is called. Consider using ` git common dir` or ` path format` to handle worktrees. Refer to linked PRs or comments for prior discussion. Also examine existing tests for git root resolution.