Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

fix(commit): emit deprecated warning of cz commit -s BEFORE going through dialog, add deprecation warning on cz commit --help #1491

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

Merged
Lee-W merged 2 commits into commitizen-tools:refactors from bearomorphism:signoff-fix
Jun 8, 2025

Conversation

Copy link
Contributor

@bearomorphism bearomorphism commented Jun 1, 2025 •
edited
Loading

Closes #1135

Description

  • Now cz commit -s emits warning before the user answers the commit questions.
  • Show deprecated warning on cz commit --help

Before (47beadc)

commitizen-py3.13➜ commitizen git:(master) cz c -s -- --allow-empty
? Select the type of change you are committing fix: A bug fix. Correlates with PATCH in SemVer
? What is the scope of this change? (class or file name): (press [enter] to skip)
 
? Write a short and imperative summary of the code changes: (lower case and no period)
 a
? Provide additional contextual information about the code changes: (press [enter] to skip)
 
? Is this a BREAKING CHANGE? Correlates with MAJOR in SemVer No
? Footer. Information about Breaking Changes and reference issues that this commit closes: (press [enter] to skip)
 
fix: a
signoff mechanic is deprecated, please use `cz commit -- -s` instead.
...

After

commitizen-py3.13➜ commitizen git:(signoff-fix) cz c -s -- --allow-empty
Deprecated warning: `cz commit -s` is deprecated and will be removed in v5, please use `cz commit -- -s` instead.
? Select the type of change you are committing (Use arrow keys)
 » fix: A bug fix. Correlates with PATCH in SemVer
 feat: A new feature. Correlates with MINOR in SemVer
 docs: Documentation only changes
 style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 refactor: A code change that neither fixes a bug nor adds a feature
 perf: A code change that improves performance
 test: Adding missing or correcting existing tests
 build: Changes that affect the build system or external dependencies (example scopes: pip, docker, npm)
 ci: Changes to CI configuration files and scripts (example scopes: GitLabCI)

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Steps to Test This Pull Request

  • Run cz c -s -- --allow-empty to see if it works.
  • Run cz c -h to see if the warning shows.

Copy link

codecov bot commented Jun 1, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.87%. Comparing base (a9cd957) to head (c31dfc2).
Report is 6 commits behind head on refactors.

Additional details and impacted files 
@@ Coverage Diff @@
## refactors #1491 +/- ##
==========================================
 Coverage 97.87% 97.87% 
==========================================
 Files 57 57 
 Lines 2677 2677 
==========================================
 Hits 2620 2620 
 Misses 57 57
Flag Coverage Δ
unittests 97.87% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bearomorphism bearomorphism marked this pull request as draft June 1, 2025 16:22
@bearomorphism bearomorphism marked this pull request as ready for review June 1, 2025 16:27
@bearomorphism bearomorphism changed the title (削除) fix(commit): emit deprecated warning of cz commit -s (削除ここまで) (追記) fix(commit): emit deprecated warning of cz commit -s BEFORE going through dialog, add deprecation warning on cz commit --help (追記ここまで) Jun 1, 2025
@Lee-W Lee-W added this to the 4.8.3 milestone Jun 8, 2025
@Lee-W Lee-W merged commit 9320f7e into commitizen-tools:refactors Jun 8, 2025
18 checks passed
@bearomorphism bearomorphism deleted the signoff-fix branch June 13, 2025 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lee-W Lee-W Lee-W approved these changes

@woile woile Awaiting requested review from woile

@noirbizarre noirbizarre Awaiting requested review from noirbizarre

Assignees
No one assigned
Projects
None yet
Milestone
4.8.3
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /