Avoid an infinite loop when git commands fail to execute when Changesets try to retrieve commits that added files - #584

🦋 Changeset detected

Latest commit: 8ac0acd

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

I will address the failing tests later - I don't think this should block the potential PR approval though (unless you think otherwise).

I will address the failing tests later - I don't think this should block the potential PR approval though (unless you think otherwise).

We've explicitly intended to support running Changesets without git and the tests failing seem like they would break that?

Could you add the command that was run to the error that is thrown?

Sure thing.

We've explicitly intended to support running Changesets without git and the tests failing seem like they would break that?

That's interesting - because the original report was stating that the infinite loop has been caused by the lack of git in the container but that would mean that our tests would not be able to complete before this change here. So there has to be some additional thing about the setup of the reporter.

Gonna try to investigate this later.

Hi @Andarist, are there any blockers on this PR? Seems like would be helpful to solve #571

Could you add the command that was run to the error that is thrown?

I ran into this infinite loop with no error printed in a GitHub Workflow when I ran changeset version in a shallow checkout without git credentials:

on:
    workflow_dispatch:
jobs:
    release:
        name: Create Release
        runs-on: ubuntu-latest
        permissions:
            contents: write
            packages: write
        steps:
            - uses: actions/checkout@v4
              with:
                  # don’t save GITHUB_TOKEN to .git/config; use credential helper instead
                  # because we don't want postinstall scripts
                  # to have access to write credentials
                  persist-credentials: false
            - name: Install node
              uses: actions/setup-node@v4
            - name: configure git to use $GIT_PASSWORD for github credential
              shell: bash
              run: |
                  set -eux
                  git config --global credential.https://github.com.helper '!f(){ test "$1" = get && printf "username=x-access-token\npassword=%s\n" "$GIT_PASSWORD"; }; f'
            - run: npm ci --ignore-scripts
            # - run: npm reinstall dependencies with postinstall scripts
            - run: npx changeset version
              env:
                # I didn’t realize that I need this:
                # GIT_PASSWORD: ${{ github.token }}

Steps to reproduce locally:

First, do a shallow clone

git clone --depth=1 --branch=<branch> https://github.com/<org>/<repo>.git

Then, remove github credentials

• e.g. if using git-credential-osxkeychain, then in Keychain Access, for the github.com Internet Password, remove git-credential-osxkeychain from authorized programs in Access Control
• e.g. if using gh auth authorize-git, remove the [credential "https://gist.github.com "] helper = "!gh auth git-credential" from ~/.gitconfig or ~/.config/git/config/

Then run changeset version

npm ci --ignore-scripts
npx changeset version

Codecov Report

❌ Patch coverage is 66.66667% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 85.49%. Comparing base (dae394c) to head (8ac0acd).

@@            Coverage Diff             @@
##             main     #584      +/-   ##
==========================================
- Coverage   85.51%   85.49%   -0.03%     
==========================================
  Files          70       70              
  Lines        2548     2550       +2     
  Branches      686      688       +2     
==========================================
+ Hits         2179     2180       +1     
- Misses        338      339       +1     
  Partials       31       31              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

We need to investigate the issue more to address the core of the problem though.

I believe #1045 may be the solution to the core problem

I agree this package isn't particularly consistent - it woul be nice to clean it up some time later.