- Notifications
You must be signed in to change notification settings - Fork261
Description
Bug Report
Description
With configurationtag_format = "{version}" instead of the defaulttag_format = "v{version}", changelog is still been generated withvX.X.X instead ofX.X.X
I have found a previous issue had been fixed for the exactly same problem#561 but the code has been refactored since then, and this exactly same issue might be implemented again at here:
python-semantic-release/src/semantic_release/version/version.py
Lines 209 to 210 ineccdb59
| defas_semver_tag(self)->str: | |
| returnf"v{self!s}" |
If I understand this correctly, the changelog template revokes this function here with the hardcoded:
python-semantic-release/config/release-templates/.components/versioned_changes.md.j2
Line 11 ineccdb59
| release.version.as_semver_tag(), |
Expected behavior
Whentag_format = "{version}", the changelog's version should format in the same way as{version}.
Actual behavior
Whentag_format = "{version}", the changelog's version unexpectedly formats asv{version}.
Environment
- Operating System (w/ version): Ubuntu 22.04
- Python version: 3.9.13
- Pip version: 22.2.2
- Semantic-release version: 9.19.1
- Build tool (w/ version): N/A
pip freeze
git log --oneline --decorate --graph --all -n 50
Configuration
Semantic Release Configuration
#.semantic-release.toml[tool.semantic_release]assets = []build_command_env = []commit_message ="{version}\n\nAutomatically generated by python-semantic-release"commit_parser ="conventional"#logging_use_named_masks =true#major_on_zero =trueallow_zero_version =trueno_git_verify =falsetag_format ="{version}"#version_variables = [][tool.semantic_release.branches.main]match ="(main|master|include-prev-changelog)"prerelease_token ="rc"prerelease =false[tool.semantic_release.changelog]template_dir ="templates"changelog_file ="CHANGELOG.md"exclude_commit_patterns = ["^(build|chore|ci|style|test)(\\(.*\\))?:.*"#]mode ="init"insertion_flag ="<!-- version list -->"[tool.semantic_release.changelog.default_templates]changelog_file ="CHANGELOG.md"output_format ="md"mask_initial_release =false[tool.semantic_release.changelog.environment]block_start_string ="{%"block_end_string ="%}"variable_start_string ="{{"variable_end_string ="}}"comment_start_string ="{#"comment_end_string ="#}"trim_blocks =falselstrip_blocks =falsenewline_sequence ="\n"keep_trailing_newline =falseextensions = []autoescape =true[tool.semantic_release.commit_author]env ="GIT_COMMIT_AUTHOR"default ="semantic-release <semantic-release>"[tool.semantic_release.commit_parser_options]other_allowed_tags = ["build","chore","ci","docs","style","refactor","test"]allowed_tags = ["feat","fix","perf","build","chore","ci","docs","style","refactor","test"]minor_tags = ["feat"]patch_tags = ["fix","perf"]default_bump_level =0parse_squash_commits =falseignore_merge_commits =false[tool.semantic_release.remote]name ="origin"type ="github"ignore_token_for_push =falseinsecure =false[tool.semantic_release.publish]dist_glob_patterns = ["dist/*"]upload_to_vcs_release =true
Build System Configuration
GitHub Actions Job Definition
Execution Log
semantic-release -c ./.semantic-release.toml -v changelog