the -u parameter in the readme is a bit misleading

[dmarticus]

Perhaps this is emergent behavior or I'm not using this tool correctly (I just used it for the first time today), but when I tried to run the tool via CLI from the root of my project repo, the README command failed when I passed in my username with the -u parameter (output below)

GET https://api.github.com/repos/dmarticus/sbt-mu-srcgen/tags?per_page=100: 404 - Not Found // See: https://developer.github.com/v3/repos/#list-tags (Octokit::NotFound)

That stacktrace made me think that I should pass in the project namespace instead of the username, and so when I tried that, it worked.

Therefore, I'd motion to update the readme (and associated references to the -u param) to mention that it should be the namespace that's being passed in to the project, not the username.

[jason-upchurch]

@dmarticus it sounds like you got it working--I just started using this tool yesterday. The short story is that I ran

github_changelog_generator -u dmarticus -p functional-todo-app --release-branch master -t <GH token>

and generated the CHANGELOG.md for your project under user dmarticus.

# Changelog

## [Unreleased](https://github.com/dmarticus/functional-todo-app/tree/HEAD)

[Full Changelog](https://github.com/dmarticus/functional-todo-app/compare/90c65d504a73af1b017d3035d83be7695710fffc...HEAD)

**Merged pull requests:**

- Update flyway-core to 6.5.2 [\#59](https://github.com/dmarticus/functional-todo-app/pull/59) ([scala-steward](https://github.com/scala-steward))
- Update finagle-http to 20.7.0 [\#58](https://github.com/dmarticus/functional-todo-app/pull/58) ([scala-steward](https://github.com/scala-steward))
- Update flyway-core to 6.5.1 [\#57](https://github.com/dmarticus/functional-todo-app/pull/57) ([scala-steward](https://github.com/scala-steward))
- Update cats-effect to 2.1.4 [\#56](https://github.com/dmarticus/functional-todo-app/pull/56) ([scala-steward](https://github.com/scala-steward))
- Update finagle-http to 20.6.0 [\#52](https://github.com/dmarticus/functional-todo-app/pull/52) ([scala-steward](https://github.com/scala-steward))
- Update sbt-bloop to 1.4.2 [\#51](https://github.com/dmarticus/functional-todo-app/pull/51) ([scala-steward](https://github.com/scala-steward))
- Update scalatest to 3.2.0 [\#50](https://github.com/dmarticus/functional-todo-app/pull/50) ([scala-steward](https://github.com/scala-steward))
- Update postgresql to 42.2.14 [\#49](https://github.com/dmarticus/functional-todo-app/pull/49) ([scala-steward](https://github.com/scala-steward))
- Update flyway-core to 6.4.4 [\#48](https://github.com/dmarticus/functional-todo-app/pull/48) ([scala-steward](https://github.com/scala-steward))
- Update postgresql to 42.2.13 [\#47](https://github.com/dmarticus/functional-todo-app/pull/47) ([scala-steward](https://github.com/scala-steward))
- Update sbt-bloop to 1.4.1 [\#46](https://github.com/dmarticus/functional-todo-app/pull/46) ([scala-steward](https://github.com/scala-steward))
- Scala steward update/finagle http 20.5.0 [\#45](https://github.com/dmarticus/functional-todo-app/pull/45) ([dmarticus](https://github.com/dmarticus))
- Update sbt to 1.3.12 [\#44](https://github.com/dmarticus/functional-todo-app/pull/44) ([scala-steward](https://github.com/scala-steward))
- Update sbt to 1.3.11 [\#43](https://github.com/dmarticus/functional-todo-app/pull/43) ([scala-steward](https://github.com/scala-steward))
- Update finagle-http to 20.5.0 [\#42](https://github.com/dmarticus/functional-todo-app/pull/42) ([scala-steward](https://github.com/scala-steward))
- Update flyway-core to 6.4.3 [\#41](https://github.com/dmarticus/functional-todo-app/pull/41) ([scala-steward](https://github.com/scala-steward))
- Update flyway-core to 6.4.2 [\#40](https://github.com/dmarticus/functional-todo-app/pull/40) ([scala-steward](https://github.com/scala-steward))
- Update scalatest to 3.1.2 [\#39](https://github.com/dmarticus/functional-todo-app/pull/39) ([scala-steward](https://github.com/scala-steward))
- Running in docker [\#38](https://github.com/dmarticus/functional-todo-app/pull/38) ([dmarticus](https://github.com/dmarticus))
- adding more todos around tracing and stuff [\#37](https://github.com/dmarticus/functional-todo-app/pull/37) ([dmarticus](https://github.com/dmarticus))
- Update flyway-core to 6.4.1 [\#36](https://github.com/dmarticus/functional-todo-app/pull/36) ([scala-steward](https://github.com/scala-steward))
- Update finagle-http to 20.4.1 [\#35](https://github.com/dmarticus/functional-todo-app/pull/35) ([scala-steward](https://github.com/scala-steward))
- Getting the acceptance tests working [\#34](https://github.com/dmarticus/functional-todo-app/pull/34) ([dmarticus](https://github.com/dmarticus))
- Update flyway-core to 6.4.0 [\#33](https://github.com/dmarticus/functional-todo-app/pull/33) ([scala-steward](https://github.com/scala-steward))
- Update finagle-http to 20.4.0 [\#32](https://github.com/dmarticus/functional-todo-app/pull/32) ([scala-steward](https://github.com/scala-steward))
- Update finagle-http to 19.12.0 [\#31](https://github.com/dmarticus/functional-todo-app/pull/31) ([scala-steward](https://github.com/scala-steward))
- Update tethys to 0.11.0 [\#30](https://github.com/dmarticus/functional-todo-app/pull/30) ([scala-steward](https://github.com/scala-steward))
- Getting the tests working [\#29](https://github.com/dmarticus/functional-todo-app/pull/29) ([dmarticus](https://github.com/dmarticus))
- Update cats-effect to 2.1.3 [\#28](https://github.com/dmarticus/functional-todo-app/pull/28) ([scala-steward](https://github.com/scala-steward))
- Update sbt to 1.3.10 [\#27](https://github.com/dmarticus/functional-todo-app/pull/27) ([scala-steward](https://github.com/scala-steward))
- Update kind-projector to 0.10.3 [\#26](https://github.com/dmarticus/functional-todo-app/pull/26) ([scala-steward](https://github.com/scala-steward))
- Update flyway-core to 6.3.3 [\#25](https://github.com/dmarticus/functional-todo-app/pull/25) ([scala-steward](https://github.com/scala-steward))
- Update scalatest to 3.1.1 [\#23](https://github.com/dmarticus/functional-todo-app/pull/23) ([scala-steward](https://github.com/scala-steward))
- Update cats-effect to 2.1.2 [\#22](https://github.com/dmarticus/functional-todo-app/pull/22) ([scala-steward](https://github.com/scala-steward))
- Update cats-core to 2.1.1 [\#21](https://github.com/dmarticus/functional-todo-app/pull/21) ([scala-steward](https://github.com/scala-steward))
- Update kind-projector to 0.10.0 [\#20](https://github.com/dmarticus/functional-todo-app/pull/20) ([scala-steward](https://github.com/scala-steward))
- Update postgresql to 42.2.12 [\#19](https://github.com/dmarticus/functional-todo-app/pull/19) ([scala-steward](https://github.com/scala-steward))
- testing travis build [\#18](https://github.com/dmarticus/functional-todo-app/pull/18) ([dmarticus](https://github.com/dmarticus))
- Update postgresql-embedded to 2.10 [\#17](https://github.com/dmarticus/functional-todo-app/pull/17) ([scala-steward](https://github.com/scala-steward))
- Update sbt-pack to 0.12 [\#16](https://github.com/dmarticus/functional-todo-app/pull/16) ([scala-steward](https://github.com/scala-steward))
- Update cats-mtl-core to 0.7.1 [\#15](https://github.com/dmarticus/functional-todo-app/pull/15) ([scala-steward](https://github.com/scala-steward))
- Update cats-effect to 1.4.0 [\#14](https://github.com/dmarticus/functional-todo-app/pull/14) ([scala-steward](https://github.com/scala-steward))
- Update cats-core to 1.6.1 [\#13](https://github.com/dmarticus/functional-todo-app/pull/13) ([scala-steward](https://github.com/scala-steward))
- Update kind-projector to 0.9.10 [\#12](https://github.com/dmarticus/functional-todo-app/pull/12) ([scala-steward](https://github.com/scala-steward))
- Update scalatest to 3.0.8 [\#11](https://github.com/dmarticus/functional-todo-app/pull/11) ([scala-steward](https://github.com/scala-steward))
- Update paradise to 2.1.1 [\#10](https://github.com/dmarticus/functional-todo-app/pull/10) ([scala-steward](https://github.com/scala-steward))
- Update sbt to 1.3.9 [\#9](https://github.com/dmarticus/functional-todo-app/pull/9) ([scala-steward](https://github.com/scala-steward))
- Update postgresql to 42.2.11 [\#8](https://github.com/dmarticus/functional-todo-app/pull/8) ([scala-steward](https://github.com/scala-steward))
- Update flyway-core to 6.3.2 [\#7](https://github.com/dmarticus/functional-todo-app/pull/7) ([scala-steward](https://github.com/scala-steward))
- Update commons-dbcp2 to 2.7.0 [\#6](https://github.com/dmarticus/functional-todo-app/pull/6) ([scala-steward](https://github.com/scala-steward))
- Update config3 to 1.0.4 [\#5](https://github.com/dmarticus/functional-todo-app/pull/5) ([scala-steward](https://github.com/scala-steward))
- Update finatra-jackson to 19.12.0 [\#4](https://github.com/dmarticus/functional-todo-app/pull/4) ([scala-steward](https://github.com/scala-steward))
- Adding logback as logger [\#3](https://github.com/dmarticus/functional-todo-app/pull/3) ([dmarticus](https://github.com/dmarticus))
- readme change [\#2](https://github.com/dmarticus/functional-todo-app/pull/2) ([dmarticus](https://github.com/dmarticus))
- migrating stuff over  [\#1](https://github.com/dmarticus/functional-todo-app/pull/1) ([dmarticus](https://github.com/dmarticus))



\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

The github-changelog-generator documentation seems most appropriately to document interaction with GitHub rather than git.

GitHub's own documentation describes the repo url format as "https://github.com/USERNAME/REPOSITORY.git" where "USERNAME" would correspond to the username for the -u parameter.

Of course you could change your GitHub username

but then:

If the new owner of your old username creates a repository with the same name as your repository, that will override the redirect entry and your redirect will stop working. Because of this possibility, we recommend you update all existing remote repository URLs after changing your username.

[dmarticus]

hey @jason-upchurch, thanks for taking the time to respond! Your explanation makes sense in that this tool is consistent in its interop with Github, and I was certainly able to use the tool without many issues after figuring out how everything worked together. In light of all that, I'm fine closing this issue out. Thanks again!

[skywinder]

Hello.
Just want to clarify:
Before there was parser of url to user and repo. But for some reason now it's deleted in one of the commits. I will take a look into this and will try to reverse this changes in order to make it user-friendly.