feat: group remote-related CLI arguments under REMOTE OPTIONS heading #1271
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️ |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1271 +/- ##
==========================================
- Coverage 43.55% 43.51% -0.03%
==========================================
Files 22 22
Lines 1984 1972 -12
==========================================
- Hits 864 858 -6
+ Misses 1120 1114 -6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
orhun
reviewed
Sep 29, 2025
Owner
orhun
left a comment
There was a problem hiding this comment.
Looks good, thanks for the PR :)
The formatting looks a bit off, can you fix it?
Also we need to update https://git-cliff.org/docs/usage/args#args with the new help output as well.
orhun
reviewed
Sep 29, 2025
Owner
orhun
left a comment
There was a problem hiding this comment.
Thanks for making the changes!
One issue that I realized is:
OPTIONS:
-i, --init [<CONFIG>] Writes the default configuration file to cliff.toml
-c, --config <PATH> Sets the configuration file [env: GIT_CLIFF_CONFIG=] [default: cliff.toml]
--config-url <URL> Sets the URL for the configuration file [env: GIT_CLIFF_CONFIG_URL=]
-w, --workdir <PATH> Sets the working directory [env: GIT_CLIFF_WORKDIR=]
-r, --repository <PATH>... Sets the git repository [env: GIT_CLIFF_REPOSITORY=]
--include-path <PATTERN>... Sets the path to include related commits [env: GIT_CLIFF_INCLUDE_PATH=]
--exclude-path <PATTERN>... Sets the path to exclude related commits [env: GIT_CLIFF_EXCLUDE_PATH=]
--tag-pattern <PATTERN> Sets the regex for matching git tags [env: GIT_CLIFF_TAG_PATTERN=]
--with-commit <MSG>... Sets custom commit messages to include in the changelog [env: GIT_CLIFF_WITH_COMMIT=]
--with-tag-message [<MSG>] Sets custom message for the latest release [env: GIT_CLIFF_WITH_TAG_MESSAGE=]
--ignore-tags <PATTERN> Sets the tags to ignore in the changelog [env: GIT_CLIFF_IGNORE_TAGS=]
--count-tags <PATTERN> Sets the tags to count in the changelog [env: GIT_CLIFF_COUNT_TAGS=]
--skip-commit <SHA1>... Sets commits that will be skipped in the changelog [env: GIT_CLIFF_SKIP_COMMIT=]
-p, --prepend <PATH> Prepends entries to the given changelog file [env: GIT_CLIFF_PREPEND=]
-o, --output [<PATH>] Writes output to the given file [env: GIT_CLIFF_OUTPUT=]
-t, --tag <TAG> Sets the tag for the latest version [env: GIT_CLIFF_TAG=]
--bump [<BUMP>] Bumps the version for unreleased changes. Optionally with specified version
-b, --body <TEMPLATE> Sets the template for the changelog body [env: GIT_CLIFF_TEMPLATE=]
--from-context <PATH> Generates changelog from a JSON context [env: GIT_CLIFF_CONTEXT=]
-s, --strip <PART> Strips the given parts from the changelog [possible values: header, footer, all]
--sort <SORT> Sets sorting of the commits inside sections [default: oldest] [possible values: oldest, newest]
ARGS:
[RANGE] Sets the commit range to process
REMOTE OPTIONS:
--github-token <TOKEN> Sets the GitHub API token [env: GITHUB_TOKEN]
--github-repo <OWNER/REPO> Sets the GitHub repository [env: GITHUB_REPO=]
--gitlab-token <TOKEN> Sets the GitLab API token [env: GITLAB_TOKEN]
--gitlab-repo <OWNER/REPO> Sets the GitLab repository [env: GITLAB_REPO=]
--gitea-token <TOKEN> Sets the Gitea API token [env: GITEA_TOKEN]
--gitea-repo <OWNER/REPO> Sets the Gitea repository [env: GITEA_REPO=]
--bitbucket-token <TOKEN> Sets the Bitbucket API token [env: BITBUCKET_TOKEN]
--bitbucket-repo <OWNER/REPO> Sets the Bitbucket repository [env: BITBUCKET_REPO=]
The remote options are now listed after ARGS. Ideally REMOTE OPTIONS should come after OPTIONS.
It might be something about the order of the arguments in the struct. Can you look into it?
orhun
approved these changes
Sep 29, 2025
Owner
orhun
left a comment
There was a problem hiding this comment.
LGTM, thanks for your contribution!
|
Congrats on merging your first pull request! ⛰️ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added
help_heading = "REMOTE OPTIONS"to all remote-related CLI arguments (--github-token,--github-repo,--gitlab-token,--gitlab-repo,--gitea-token,--gitea-repo,--bitbucket-token,--bitbucket-repo) to group them under a dedicated "REMOTE OPTIONS" section in the help output.Motivation and Context
Fixes #1270
How Has This Been Tested?
cargo buildgit-cliff -hto verify the help output shows the new "REMOTE OPTIONS" sectioncargo testto ensure CLI argument parsing tests pass (theverify_clitest validates the argument structure)Screenshots / Logs (if applicable)
Types of Changes
Checklist: