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

docs(README.md): update poetry dev dependency usage #619

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

Conversation

Copy link

@Aleksandar1932 Aleksandar1932 commented Nov 16, 2022

Since Poetry 1.2.0 dependency groups are introduced, and --dev becomes deprecated, and instead --with dev has to be provided. This PR updates the documentation to reflect this change.

Description

Change the documentation in order to reflect the updated way for dependency groups.

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

The documentation can be followed as it is, instead of getting warnings/ errors.

Steps to Test This Pull Request

  1. Review the documentation, and wether it reflects the desired state

Additional context

image

Since Poetry 1.2.0 dependency groups are introduced, and `--dev` becomes deprecated, and instead `--with dev` has to be provided.

```bash
poetry add commitizen --dev
poetry add commitizen --group dev
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of just use --group, I might suggest add poetry version as well. e.g.,

# for poetry >= 1.2.0
...
# for poetry < 1.2.0

Copy link
Author

@Aleksandar1932 Aleksandar1932 Nov 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, updated.

Copy link
Member

@woile woile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Merge when you think is ready @Lee-W .
Thanks 🎉

Lee-W and Aleksandar1932 reacted with thumbs up emoji
@Lee-W Lee-W merged commit 6b8ac42 into commitizen-tools:master Nov 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@woile woile woile approved these changes

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

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

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