Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

best CLI requires git to run #184

Open
pmdartus opened this issue Jul 29, 2019 · 2 comments
Open

best CLI requires git to run #184

pmdartus opened this issue Jul 29, 2019 · 2 comments
Labels

Comments

@pmdartus
Copy link
Member

pmdartus commented Jul 29, 2019

Observations

Following the getting started, when running the yarn best command the CLI throws the following error:

ERROR     Error: Unable to read git information
    at generateProjectConfigs (/Users/p.dartus/code/github/pmdartus/benchmark-ci-test/node_modules/@best/config/build/index.js:10:19)
    at readConfig (/Users/p.dartus/code/github/pmdartus/benchmark-ci-test/node_modules/@best/config/build/index.js:68:45)
    at process._tickCallback (internal/process/next_tick.js:68:7)
error Command failed with exit code 1.

Does best should absolutely require to be run in a git enabled directory? If it is the case then the documentation needs to be updated.

Update:
I took me multiple attempts to make the best CLI happy:

  • after running git init, best requires at least 1 commit on the master branch.
  • after running git commit, best requires at least a remote to be present.
  • after adding a remote, best is still not happy here. I created a specific issue for this error git remote URL regexp is too restrictive #185

Versions

  • node: 10.16.0
  • best: 4.0.0-alpha4
@jasonsilberman
Copy link
Contributor

That’s a good question. I believe there are a good number of things that assume the Git info will be available, but that should be reasonably easy to fix since we have types!

What do you think @diervo, should we require users to run Best in a git enabled directory?

@diervo
Copy link
Contributor

diervo commented Jul 29, 2019

I think we should, otherwise we can't do comparison or tracking. If anything we could add a flag to ignore git for specific cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants