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

doc: fix confusion about the name of this package #163

Closed

Conversation

jbrains
Copy link

@jbrains jbrains commented Aug 29, 2021

When I tried to install this package, I was confused about whether it was gitlab-cli or git-lab-cli, and so I installed the package gitlab-ci and that didn't install any binaries. I have updated the README to try to reduce confusion for the next person.

@commit-lint
Copy link

commit-lint bot commented Aug 29, 2021

Bug Fixes

  • confusion about the name of this package (28ae313)

Contributors

jbrains

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR:

  • @Commit-Lint merge patch will merge dependabot PR on "patch" versions (X.X.Y - Y change)
  • @Commit-Lint merge minor will merge dependabot PR on "minor" versions (X.Y.Y - Y change)
  • @Commit-Lint merge major will merge dependabot PR on "major" versions (Y.Y.Y - Y change)
  • @Commit-Lint merge disable will desactivate merge dependabot PR
  • @Commit-Lint review will approve dependabot PR
  • @Commit-Lint stop review will stop approve dependabot PR

When I tried to install this package, I was confused about whether it was gitlab-cli or git-lab-cli, and so I installed the package gitlab-ci and that didn't install any binaries. I have updated the README to try to reduce confusion for the next person.
@jbrains jbrains closed this Aug 29, 2021
@jbrains jbrains reopened this Aug 29, 2021
@jbrains
Copy link
Author

jbrains commented Aug 29, 2021

I believe that I have fixed the commit comment, so I don't know why commit-lint-pr is still complaining.

@vishwanatharondekar vishwanatharondekar changed the title Fix confusion about the name of this package doc: Fix confusion about the name of this package Aug 31, 2021
@vishwanatharondekar vishwanatharondekar changed the title doc: Fix confusion about the name of this package doc: fix confusion about the name of this package Aug 31, 2021
@vishwanatharondekar
Copy link
Owner

vishwanatharondekar commented Aug 31, 2021

I actually wanted gitlab-cli but it was already taken in npm registry. I had created github repo long before I tried publishing on npm. I am not sure I want to take this and still keep the repo name same. That will confuse users. Also renaming repo might not be an option. Give me some time to think about this before taking call to merge or not.

Please note readme does tell you how to install with correct name.

@jbrains
Copy link
Author

jbrains commented Aug 31, 2021

I understand how you got there and your concern. Have you already tried contacting the author of gitlab-ci to ask them to abandon their project and give you the name?

@vishwanatharondekar
Copy link
Owner

I had contacted the owner of https://www.npmjs.com/package/gitlab-cli 4 years back. Didn't go well because purpose of both projects were bit different and merging those would have required a lot of work we were not ready for.

@jbrains
Copy link
Author

jbrains commented Aug 31, 2021

You can almost certainly rename the repository in Github. You might need to spend a few moments to figure out all the various places where you need to change that setting, but it should work.

If you'd like any help, I can try to help, although I'm a little bit of a bottleneck lately. :) I know that this isn't highly urgent, so we can take our time.

@vishwanatharondekar
Copy link
Owner

I agree with the confusion part but none of the solutions are foolproof and bring some or the other implication or confusion. I am deciding to go against merging this. This is not solving the issue we have. We can live with what we have right now.

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

Successfully merging this pull request may close these issues.

None yet

2 participants