Add an remote_url config option

[pedro-psb]

Is your feature request related to a problem? Please describe.

The only way to customize the URL generated in the changelog title (e.g, to point to a github tag) is using the envvar GIT_CHANGELOG_REMOTE, which accepts only remote names.

In different machines (including CI), remote names can be different, which makes it inconvenient to automate. E.g.:

I may create a script to use the upstream remote, which points to the original project remote. A different machine may use myupstream, which will produce break the script.

Describe the solution you'd like

Allow to pass the remote URL in the config and CLI args:

remote_url="https://github.com/myorg/myproject.git"

git-changelog --remote-url "https://github.com/myorg/myproject.git"

Describe alternatives you've considered

Not sure.

Additional context

[pawamoy]

Sounds like a good idea :slightly_smiling_face:

I therefore suggest we implement all the following:

• support for a --remote-url CLI option
• support for a remote_url configuration option
• support for a GIT_CHANGELOG_REMOTE_URL env var
• support for a --remote CLI option (remote name)

I don't think the environment variables are currently documented, we should document them too.

[pedro-psb]

You mean, to have it as an envvar and cli-arg only, and not as an option in the config file?

[pawamoy]

Sorry, I meant in addition to the configuration option :smile: Let me edit my comment.