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

2.0.0 breaking changes #230

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 5 commits into next from 2.0.0-break-changes
Jul 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 2 additions & 24 deletions commitizen/cli.py
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import argparse
import logging
import sys
import warnings
from functools import partial

from decli import cli
Expand All @@ -24,16 +23,10 @@
"name": ["-n", "--name"],
"help": "use the given commitizen (default: cz_conventional_commits)",
},
{
"name": ["--version"],
"action": "store_true",
"help": "get the version of the installed commitizen",
},
],
"subcommands": {
"title": "commands",
# TODO: Add this constraint back in 2.0
# "required": True,
"required": True,
"commands": [
{
"name": ["init"],
Expand Down Expand Up @@ -278,26 +271,11 @@ def main():
elif not args.name and not conf.path:
conf.update({"name": "cz_conventional_commits"})

if args.version:
warnings.warn(
(
"'cz --version' will be deprecated in next major version. "
"Please use 'cz version' command from your scripts"
),
category=DeprecationWarning,
)
args.func = commands.Version

if args.debug:
logging.getLogger("commitizen").setLevel(logging.DEBUG)
sys.excepthook = commitizen_debug_excepthook

# TODO: This try block can be removed after command is required in 2.0
# Handle the case that argument is given, but no command is provided
try:
args.func(conf, vars(args))()
except AttributeError:
raise NoCommandFoundError()
args.func(conf, vars(args))()


if __name__ == "__main__":
Expand Down
8 changes: 3 additions & 5 deletions commitizen/commands/init.py
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
from packaging.version import Version

from commitizen import factory, out
from commitizen.config import BaseConfig, IniConfig, TomlConfig
from commitizen.config import BaseConfig, TomlConfig
from commitizen.cz import registry
from commitizen.defaults import long_term_support_config_files
from commitizen.defaults import config_files
from commitizen.exceptions import NoAnswersError
from commitizen.git import get_latest_tag_name, get_tag_names

Expand All @@ -23,8 +23,6 @@ def __call__(self):

if "toml" in config_path:
self.config = TomlConfig(data="", path=config_path)
else:
self.config = IniConfig(data="", path=config_path)

self.config.init_empty_config_content()

Expand All @@ -43,7 +41,7 @@ def __call__(self):
def _ask_config_path(self) -> str:
name = questionary.select(
"Please choose a supported config file: (default: pyproject.toml)",
choices=long_term_support_config_files,
choices=config_files,
default="pyproject.toml",
style=self.cz.style,
).ask()
Expand Down
35 changes: 1 addition & 34 deletions commitizen/config/__init__.py
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,11 @@
import warnings
from pathlib import Path
from typing import Optional, Union

from commitizen import defaults, git

from .base_config import BaseConfig
from .ini_config import IniConfig
from .toml_config import TomlConfig


def load_global_conf() -> Optional[IniConfig]:
home = Path.home()
global_cfg = home / Path(".cz")
if not global_cfg.exists():
return None

# global conf doesn't make sense with commitizen bump
# so I'm deprecating it and won't test it
message = (
"Global conf will be deprecated in next major version. "
"Use per project configuration. "
"Remove '~/.cz' file from your conf folder."
)
warnings.simplefilter("always", DeprecationWarning)
warnings.warn(message, category=DeprecationWarning)

with open(global_cfg, "r") as f:
data = f.read()

conf = IniConfig(data=data, path=global_cfg)
return conf


def read_cfg() -> BaseConfig:
conf = BaseConfig()

Expand All @@ -52,21 +26,14 @@ def read_cfg() -> BaseConfig:
with open(filename, "r") as f:
data: str = f.read()

_conf: Union[TomlConfig, IniConfig]
_conf: TomlConfig
if "toml" in filename.suffix:
_conf = TomlConfig(data=data, path=filename)
else:
_conf = IniConfig(data=data, path=filename)

if _conf.is_empty_config:
continue
else:
conf = _conf
break

if not conf.path:
global_conf = load_global_conf()
if global_conf:
conf = global_conf

return conf
14 changes: 0 additions & 14 deletions commitizen/config/base_config.py
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import warnings
from pathlib import Path
from typing import Any, Dict, Optional, Union

Expand Down Expand Up @@ -34,16 +33,3 @@ def add_path(self, path: Union[str, Path]):

def _parse_setting(self, data: str) -> dict:
raise NotImplementedError()

# TODO: remove "files" supported in 2.0
@classmethod
def _show_files_column_deprecated_warning(cls):
warnings.simplefilter("always", DeprecationWarning)
warnings.warn(
(
'"files" is renamed as "version_files" '
"and will be deprecated in next major version\n"
'Please repalce "files" with "version_files"'
),
category=DeprecationWarning,
)
76 changes: 0 additions & 76 deletions commitizen/config/ini_config.py
View file Open in desktop

This file was deleted.

4 changes: 0 additions & 4 deletions commitizen/config/toml_config.py
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,3 @@ def _parse_setting(self, data: str):
self.settings.update(doc["tool"]["commitizen"])
except exceptions.NonExistentKey:
self.is_empty_config = True

if "files" in self.settings:
self.settings["version_files"] = self.settings["files"]
TomlConfig._show_files_column_deprecated_warning
7 changes: 2 additions & 5 deletions commitizen/defaults.py
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
from collections import OrderedDict
from typing import Any, Dict
from typing import Any, Dict, List

name: str = "cz_conventional_commits"
# TODO: .cz, setup.cfg, .cz.cfg should be removed in 2.0
long_term_support_config_files: list = ["pyproject.toml", ".cz.toml"]
deprcated_config_files: list = [".cz", "setup.cfg", ".cz.cfg"]
config_files: list = long_term_support_config_files + deprcated_config_files
config_files: List[str] = ["pyproject.toml", ".cz.toml"]

DEFAULT_SETTINGS: Dict[str, Any] = {
"name": "cz_conventional_commits",
Expand Down
25 changes: 0 additions & 25 deletions docs/bump.md
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,6 @@ However, it will still update `pyproject.toml` and `src/__version__.py`.
To fix it, you'll first `git checkout .` to reset to the status before trying to bump and update
the version in `setup.py` to `1.21.0`


## Configuration

### `tag_format`
Expand All @@ -155,13 +154,6 @@ In your `pyproject.toml` or `.cz.toml`
tag_format = "v$minor.$major.$patch$prerelease"
```

Or in your `.cz` (TO BE DEPRECATED)

```ini
[commitizen]
tag_format = v$minor.$major.$patch$prerelease
```

The variables must be preceded by a `$` sign.

Supported variables:
Expand Down Expand Up @@ -198,16 +190,6 @@ version_files = [
]
```

`.cz` (TO BE DEPRECATED)

```ini
[commitizen]
version_files = [
"src/__version__.py",
"setup.py:version"
]
```

In the example above, we can see the reference `"setup.py:version"`.
This means that it will find a file `setup.py` and will only make a change
in a line containing the `version` substring.
Expand All @@ -234,13 +216,6 @@ Some examples
bump_message = "release $current_version → $new_version [skip-ci]"
```

`.cz` (TO BE DEPRECATED)

```ini
[commitizen]
bump_message = release $current_version → $new_version [skip-ci]
```

## Custom bump

Read the [customizing section](./customization.md).
Expand Down
35 changes: 1 addition & 34 deletions docs/config.md
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Configuration

Commitizen has support for `toml` and `ini` files. It first looks up the configuration file in the current working directory and then the root directory of the git project.

## pyproject.toml or .cz.toml

Add an entry to `pyproject.toml` or `.cz.toml`. Recommended for **python** projects.
Expand All @@ -28,38 +26,7 @@ style = [
]
```

## INI files

**INI files will not be supported in the next major version. Please use toml instead**

Supported files: `.cz`, `.cz.cfg`, `setup.cfg`, and `$HOME/.cz`

The format is slightly different to the `toml`, so pay attention.
Recommended for **other languages** projects (js, go, etc).

```ini
[commitizen]
name = cz_conventional_commits
version = 0.1.0
version_files = [
"src/__version__.py",
"pyproject.toml:version"
]
style = [
["qmark", "fg:#ff9d00 bold"],
["question", "bold"],
["answer", "fg:#ff9d00 bold"],
["pointer", "fg:#ff9d00 bold"],
["highlighted", "fg:#ff9d00 bold"],
["selected", "fg:#cc5454"],
["separator", "fg:#cc5454"],
["instruction", ""],
["text", ""],
["disabled", "fg:#858585 italic"]
]
```

The extra tab before the square brackets (`]`) at the end is required.
`.cz.toml` is recommended for **other languages** projects (js, go, etc).

## Settings

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ classifiers = [
[tool.poetry.dependencies]
python = "^3.6.1"
questionary = "^1.4.0"
decli = "^0.5.0"
decli = "^0.5.2"
colorama = "^0.4.1"
termcolor = "^1.1"
packaging = ">=19,<21"
Expand Down
Loading

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