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

Add a CLI flag for disabling the command execution #333

Closed
orhun opened this issue Oct 29, 2023 · 4 comments · Fixed by #458
Closed

Add a CLI flag for disabling the command execution #333

orhun opened this issue Oct 29, 2023 · 4 comments · Fixed by #458
Assignees
Labels
feature/request New feature or request good first issue Good for newcomers

Comments

@orhun
Copy link
Owner

orhun commented Oct 29, 2023

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

The default config of git-cliff now runs typos to fix the typos in the commits:

git-cliff/cliff.toml

Lines 66 to 71 in 3c2fb60

commit_preprocessors = [
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))" },
# Check spelling of the commit with https://github.com/crate-ci/typos
# If the spelling is incorrect, it will be automatically fixed.
{ pattern = '.*', replace_command = 'typos --write-changes -' },
]

Thus generating a changelog for the whole git history takes some time.

Describe the solution you'd like

We should add a command-line flag for disabling command execution in the cases where the user wants to generate a changelog without running external commands.

For example, git-cliff --no-exec will skip executing the commands defined in replace_command.

Describe alternatives you've considered

None.

Additional context

See #316 for additional discussion about typos implementation.

@orhun orhun added feature/request New feature or request good first issue Good for newcomers labels Oct 29, 2023
@mamaicode
Copy link

Hey, this is still relevant?
@orhun

@orhun
Copy link
Owner Author

orhun commented Nov 28, 2023

Hello @mamaicode 👋🏼

Yup, are you interested in making a PR? 🐻

@mamaicode
Copy link

Yep! Will look into this

@orhun
Copy link
Owner Author

orhun commented Dec 3, 2023

Kindly ping 🐻 do you need any guidance on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/request New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants