Skip to content

feat(commands)!: deprecate '-s' signoff parameter - #1221

Closed
AdrianDC wants to merge 7 commits into
commitizen-tools:v4from
AdrianDC:signoff-v4
Closed

feat(commands)!: deprecate '-s' signoff parameter#1221
AdrianDC wants to merge 7 commits into
commitizen-tools:v4from
AdrianDC:signoff-v4

Conversation

@AdrianDC

Copy link
Copy Markdown
Contributor

Description

feat(commands)!: deprecate '-s' signoff parameter

Follow-up to #1206, deprecating -s for major v4.

Checklist

  • Add test cases to all the changes you introduce
  • Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

Steps to Test This Pull Request

Additional context

dependabotBotand others added 6 commits August 23, 2024 10:18
Bumps [ruff](https://github.com/astral-sh/ruff) from 0.6.1 to 0.6.2.
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](astral-sh/ruff@0.6.1...0.6.2)
---
updated-dependencies:
- dependency-name: ruff
dependency-type: direct:development
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>
If 'always_signoff' is enabled in configurations, or '-s' is used alone on the CLI,
the following errors arise due to 'git commit' argument failures :
> signoff mechanic is deprecated, please use `cz commit -- -s` instead.
> fatal: /tmp/...: '/tmp/... is outside repository at '...'
Signed-off-by: Adrian DC <radian.dc@gmail.com>
Signed-off-by: Adrian DC <radian.dc@gmail.com>
Signed-off-by: Adrian DC <radian.dc@gmail.com>
Signed-off-by: Adrian DC <radian.dc@gmail.com>
…nd sources
Details: The git sources folder ownership may be detected as dubious if running
in a container with sources mounted to work on fixes and tests,
breaking 'test_find_git_project_root' and 'test_get_commits_with_signature'
> commitizen.exceptions.GitCommandError: fatal: detected dubious ownership in repository at '...'
---
Signed-off-by: Adrian DC <radian.dc@gmail.com>
@codecov

codecovBot commented Aug 25, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (v4@737c24c). Learn more about missing BASE report.

Additional details and impacted files
@@ Coverage Diff @@## v4 #1221 +/- ##
=====================================
Coverage ? 97.61% =====================================
Files ? 55 Lines ? 2515 Branches ? 0 =====================================
Hits ? 2455 Misses ? 60 Partials ? 0 
FlagCoverage Δ
unittests97.61% <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.

Signed-off-by: Adrian DC <radian.dc@gmail.com>
@AdrianDC

Copy link
Copy Markdown
ContributorAuthor

Though implemented per request towards v4, I vote against my own PR,
because some of my teams' developers use it all the time as this is considered "basic" / "normal" usage.

@Lee-W

Lee-W commented Nov 2, 2024

Copy link
Copy Markdown
Member

Though implemented per request towards v4, I vote against my own PR, because some of my teams' developers use it all the time as this is considered "basic" / "normal" usage.

I'm ok to keep a few exceptions. As long as the underlying logic is not duplicate and the document is suggesting using --

@AdrianDC

Copy link
Copy Markdown
ContributorAuthor

Deprecation of -s canceled for commitizen v4 👍

@AdrianDCAdrianDC closed this Nov 4, 2024
@AdrianDC
AdrianDC deleted the signoff-v4 branch November 16, 2024 11:48
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@AdrianDC@Lee-W