commitizen/commitizen/commands/bump.py at master · commitizen-tools/commitizen · GitHub

History

446 lines (396 loc) · 16.4 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

from __future__ import annotations

import warnings

from logging import getLogger

from typing import TYPE_CHECKING, cast

import questionary

from commitizen import bump, factory, git, hooks, out

from commitizen.changelog_formats import get_changelog_format

from commitizen.commands.changelog import Changelog

from commitizen.defaults import Settings

from commitizen.exceptions import (

BumpCommitFailedError,

BumpTagFailedError,

DryRunExit,

ExpectedExit,

InvalidManualVersion,

NoCommitsFoundError,

NoneIncrementExit,

NoPatternMapError,

NotAGitProjectError,

NotAllowed,

)

from commitizen.providers import get_provider

from commitizen.tags import TagRules

from commitizen.version_schemes import (

Increment,

InvalidVersion,

Prerelease,

VersionProtocol,

get_version_scheme,

)

if TYPE_CHECKING:

from commitizen.config import BaseConfig

logger = getLogger("commitizen")

class BumpArgs(Settings, total=False):

allow_no_commit: bool | None

annotated_tag_message: str | None

build_metadata: str | None

changelog_to_stdout: bool

changelog: bool

check_consistency: bool

devrelease: int | None

dry_run: bool

file_name: str

files_only: bool | None

version_files_only: bool | None

get_next: bool # TODO: maybe rename to `next_version_to_stdout`

git_output_to_stderr: bool

increment_mode: str

increment: Increment | None

local_version: bool

manual_version: str | None

no_verify: bool

prerelease: Prerelease | None

retry: bool

yes: bool

class Bump:

"""Show prompt for the user to create a guided commit."""

def __init__(self, config: BaseConfig, arguments: BumpArgs) -> None:

if not git.is_git_project():

raise NotAGitProjectError()

self.config: BaseConfig = config

self.arguments = arguments

self.bump_settings = cast(

"BumpArgs",

{

**config.settings,

**{

k: v

for k in (

"annotated_tag_message",

"annotated_tag",

"bump_message",

"file_name",

"gpg_sign",

"increment_mode",

"increment",

"major_version_zero",

"prerelease_offset",

"prerelease",

"tag_format",

"template",

)

if (v := arguments.get(k)) is not None

)

self.cz = factory.committer_factory(self.config)

self.changelog_flag = arguments["changelog"]

self.changelog_to_stdout = arguments["changelog_to_stdout"]

self.git_output_to_stderr = arguments["git_output_to_stderr"]

self.no_verify = arguments["no_verify"]

self.check_consistency = arguments["check_consistency"]

self.retry = arguments["retry"]

self.pre_bump_hooks = self.config.settings["pre_bump_hooks"]

self.post_bump_hooks = self.config.settings["post_bump_hooks"]

deprecated_version_type = arguments.get("version_type")

if deprecated_version_type:

warnings.warn(

DeprecationWarning(

"`--version-type` parameter is deprecated and will be removed in v5. "

"Please use `--version-scheme` instead"

)

self.scheme = get_version_scheme(

self.config.settings, arguments["version_scheme"] or deprecated_version_type

)

self.file_name = arguments["file_name"] or self.config.settings.get(

"changelog_file"

)

self.changelog_format = get_changelog_format(self.config, self.file_name)

self.template = (

arguments["template"]

or self.config.settings.get("template")

or self.changelog_format.template

)

self.extras = arguments["extras"]

def _is_initial_tag(

self, current_tag: git.GitTag | None, is_yes: bool = False

) -> bool:

"""Check if reading the whole git tree up to HEAD is needed."""

if current_tag:

return False

if is_yes:

return True

out.info("No tag matching configuration could be found.")

out.info(

"Possible causes:\n"

"- version in configuration is not the current version\n"

"- tag_format or legacy_tag_formats is missing, check them using 'git tag --list'\n"

)

return bool(questionary.confirm("Is this the first tag created?").ask())

def _find_increment(self, commits: list[git.GitCommit]) -> Increment | None:

# Update the bump map to ensure major version doesn't increment.

# self.cz.bump_map = defaults.bump_map_major_version_zero

bump_map = (

self.cz.bump_map_major_version_zero

if self.bump_settings["major_version_zero"]

else self.cz.bump_map

)

bump_pattern = self.cz.bump_pattern

if not bump_map or not bump_pattern:

raise NoPatternMapError(

f"'{self.config.settings['name']}' rule does not support bump"

)

return bump.find_increment(commits, regex=bump_pattern, increments_map=bump_map)

def _validate_arguments(self, current_version: VersionProtocol) -> None:

errors: list[str] = []

if self.arguments["manual_version"]:

for val, option in (

(self.arguments["increment"], "--increment"),

(self.arguments["prerelease"], "--prerelease"),

(self.arguments["devrelease"] is not None, "--devrelease"),

(self.arguments["local_version"], "--local-version"),

(self.arguments["build_metadata"], "--build-metadata"),

(self.arguments["major_version_zero"], "--major-version-zero"),

if val:

errors.append(f"{option} cannot be combined with MANUAL_VERSION")

if self.arguments["major_version_zero"] and current_version.release[0]:

errors.append(

f"--major-version-zero is meaningless for current version {current_version}"

)

if self.arguments["build_metadata"] and self.arguments["local_version"]:

errors.append("--local-version cannot be combined with --build-metadata")

if errors:

raise NotAllowed("\n".join(errors))

def _resolve_increment_and_new_version(

self, current_version: VersionProtocol, current_tag: git.GitTag | None

) -> tuple[Increment | None, VersionProtocol]:

increment = self.arguments["increment"]

if manual_version := self.arguments["manual_version"]:

try:

return increment, self.scheme(manual_version)

except InvalidVersion as exc:

raise InvalidManualVersion(

"[INVALID_MANUAL_VERSION]\n"

f"Invalid manual version: '{manual_version}'"

) from exc

if increment is None:

commits = git.get_commits(current_tag.name if current_tag else None)

# No commits, there is no need to create an empty tag.

# Unless we previously had a prerelease.

if (

not commits

and not current_version.is_prerelease

and not self.arguments["allow_no_commit"]

raise NoCommitsFoundError("[NO_COMMITS_FOUND]\nNo new commits found.")

increment = self._find_increment(commits)

# It may happen that there are commits, but they are not eligible

# for an increment, this generates a problem when using prerelease (#281)

if (

self.arguments["prerelease"]

and increment is None

and not current_version.is_prerelease

raise NoCommitsFoundError(

"[NO_COMMITS_FOUND]\n"

"No commits found to generate a pre-release.\n"

"To avoid this error, manually specify the type of increment with `--increment`"

)

# we create an empty PATCH increment for empty tag

if increment is None and self.arguments["allow_no_commit"]:

increment = "PATCH"

return increment, current_version.bump(

increment,

prerelease=self.arguments["prerelease"],

prerelease_offset=self.bump_settings["prerelease_offset"],

devrelease=self.arguments["devrelease"],

is_local_version=self.arguments["local_version"],

build_metadata=self.arguments["build_metadata"],

exact_increment=self.arguments["increment_mode"] == "exact",

)

def __call__(self) -> None:

"""Steps executed to bump."""

provider = get_provider(self.config)

current_version = self.scheme(provider.get_version())

self._validate_arguments(current_version)

next_version_to_stdout = self.arguments["get_next"]

if next_version_to_stdout:

for value, option in (

(self.changelog_flag, "--changelog"),

(self.changelog_to_stdout, "--changelog-to-stdout"),

if value:

warnings.warn(f"{option} has no effect when used with --get-next")

# If user specified changelog_to_stdout, they probably want the

# changelog to be generated as well, this is the most intuitive solution

self.changelog_flag = any(

(

self.changelog_flag,

self.changelog_to_stdout,

self.config.settings.get("update_changelog_on_bump"),

)

rules = TagRules.from_settings(cast("Settings", self.bump_settings))

current_tag = rules.find_tag_for(git.get_tags(), current_version)

current_tag_version = (

current_tag.name if current_tag else rules.normalize_tag(current_version)

)

is_initial = self._is_initial_tag(current_tag, self.arguments["yes"])

increment, new_version = self._resolve_increment_and_new_version(

current_version, current_tag

)

new_tag_version = rules.normalize_tag(new_version)

if next_version_to_stdout:

if increment is None and new_tag_version == current_tag_version:

raise NoneIncrementExit(

"[NO_COMMITS_TO_BUMP]\n"

"The commits found are not eligible to be bumped"

)

out.write(str(new_version))

raise DryRunExit()

message = bump.create_commit_message(

current_version, new_version, self.bump_settings["bump_message"]

)

# Report found information

information = f"{message}\ntag to create: {new_tag_version}\n"

if increment:

information += f"increment detected: {increment}\n"

if self.changelog_to_stdout:

# When the changelog goes to stdout, we want to send

# the bump information to stderr, this way the

# changelog output can be captured

out.diagnostic(information)

else:

out.write(information)

if increment is None and new_tag_version == current_tag_version:

raise NoneIncrementExit(

"[NO_COMMITS_TO_BUMP]\nThe commits found are not eligible to be bumped"

)

updated_files: list[str] = []

changelog_file_name = None

dry_run = self.arguments["dry_run"]

if self.changelog_flag:

changelog_args = {

"unreleased_version": new_tag_version,

"template": self.template,

"extras": self.extras,

"incremental": True,

"dry_run": dry_run,

# governs logic for merge_prerelease

"during_version_bump": self.arguments["prerelease"] is None,

}

if self.changelog_to_stdout:

try:

Changelog(

self.config,

{**changelog_args, "dry_run": True}, # type: ignore[typeddict-item]

)()

except DryRunExit:

pass

changelog_cmd = Changelog(

self.config,

{

**changelog_args, # type: ignore[typeddict-item]

"file_name": self.file_name,

"allow_no_commit": bool(self.arguments["allow_no_commit"]),

)

changelog_cmd()

changelog_file_name = changelog_cmd.file_name

updated_files.append(changelog_file_name)

# Do not perform operations over files or git.

if dry_run:

raise DryRunExit()

updated_files.extend(

bump.update_version_in_files(

str(current_version),

str(new_version),

self.bump_settings["version_files"],

check_consistency=self.check_consistency,

encoding=self.config.settings["encoding"],

)

provider.set_version(str(new_version))

if self.pre_bump_hooks:

hooks.run(

self.pre_bump_hooks,

_env_prefix="CZ_PRE_",

is_initial=is_initial,

current_version=str(current_version),

current_tag_version=current_tag_version,

new_version=new_version.public,

new_tag_version=new_tag_version,

message=message,

increment=increment,

changelog_file_name=changelog_file_name,

)

if self.arguments.get("files_only"):

warnings.warn(

"--files-only is deprecated and will be removed in v5. Use --version-files-only instead.",

DeprecationWarning,

)

raise ExpectedExit()

if self.arguments.get("version_files_only"):

raise ExpectedExit()

# FIXME: check if any changes have been staged

git.add(*updated_files)

c = git.commit(message, args=self._get_commit_args())

if self.retry and c.return_code != 0 and self.changelog_flag:

# Maybe pre-commit reformatted some files? Retry once

logger.debug("1st git.commit error: %s", c.err)

logger.info("1st commit attempt failed; retrying once")

git.add(*updated_files)

c = git.commit(message, args=self._get_commit_args())

if c.return_code != 0:

err = c.err.strip() or c.out

raise BumpCommitFailedError(f'2nd git.commit error: "{err}"')

for msg in (c.out, c.err):

if msg:

out_func = out.diagnostic if self.git_output_to_stderr else out.write

out_func(msg)

c = git.tag(

new_tag_version,

signed=any(

(

self.bump_settings.get("gpg_sign"),

self.config.settings.get("gpg_sign"),

)

annotated=any(

(

self.bump_settings.get("annotated_tag"),

self.config.settings.get("annotated_tag"),

self.bump_settings.get("annotated_tag_message"),

)

msg=self.bump_settings.get("annotated_tag_message", None),

# TODO: also get from self.config.settings?

)

if c.return_code != 0:

raise BumpTagFailedError(c.err)

if self.post_bump_hooks:

hooks.run(

self.post_bump_hooks,

_env_prefix="CZ_POST_",

was_initial=is_initial,

previous_version=str(current_version),

previous_tag_version=current_tag_version,

current_version=new_version.public,

current_tag_version=new_tag_version,

message=message,

increment=increment,

changelog_file_name=changelog_file_name,

)

# TODO: For v3 output this only as diagnostic and remove this if

if self.changelog_to_stdout:

out.diagnostic("Done!")

else:

out.success("Done!")

def _get_commit_args(self) -> list[str]:

commit_args = ["-a"]

if self.no_verify:

commit_args.append("--no-verify")

return commit_args

commitizen/commitizen/commands/bump.py at master · commitizen-tools/commitizen · GitHub

Uh oh!

Uh oh!

commitizen/commitizen/commands/bump.py at master · commitizen-tools/commitizen · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

bump.py

Latest commit

History

Breadcrumbs

bump.py

File metadata and controls