File: changelog_writer.py

package info (click to toggle)
python-semantic-release 10.5.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,980 kB
  • sloc: python: 43,374; sh: 695; makefile: 158
file content (281 lines) | stat: -rw-r--r-- 9,284 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
from __future__ import annotations

import os
from contextlib import suppress
from pathlib import Path
from typing import TYPE_CHECKING

# NOTE: use backport with newer API than stdlib
from importlib.resources import files

import semantic_release
from semantic_release.changelog.context import (
    ReleaseNotesContext,
    autofit_text_width,
    create_pypi_url,
    make_changelog_context,
)
from semantic_release.changelog.template import environment, recursive_render
from semantic_release.cli.config import ChangelogOutputFormat
from semantic_release.cli.const import (
    DEFAULT_CHANGELOG_NAME_STEM,
    DEFAULT_RELEASE_NOTES_TPL_FILE,
    JINJA2_EXTENSION,
)
from semantic_release.cli.util import noop_report
from semantic_release.errors import InternalError
from semantic_release.globals import logger
from semantic_release.helpers import sort_numerically

if TYPE_CHECKING:  # pragma: no cover
    from jinja2 import Environment

    from semantic_release.changelog.context import ChangelogContext
    from semantic_release.changelog.release_history import Release, ReleaseHistory
    from semantic_release.cli.config import RuntimeContext
    from semantic_release.hvcs._base import HvcsBase


def get_default_tpl_dir(style: str, sub_dir: str | None = None) -> Path:
    module_base_path = Path(str(files(semantic_release.__name__)))
    default_templates_path = module_base_path.joinpath(
        f"data/templates/{style}",
        "" if sub_dir is None else sub_dir.strip("/"),
    )

    if default_templates_path.is_dir():
        return default_templates_path

    raise InternalError(
        str.join(
            " ",
            [
                "Default template directory not found at",
                f"{default_templates_path}. Installation corrupted!",
            ],
        )
    )


def render_default_changelog_file(
    output_format: ChangelogOutputFormat,
    changelog_context: ChangelogContext,
    changelog_style: str,
) -> str:
    tpl_dir = get_default_tpl_dir(style=changelog_style, sub_dir=output_format.value)
    changelog_tpl_file = Path(DEFAULT_CHANGELOG_NAME_STEM).with_suffix(
        str.join(".", ["", output_format.value, JINJA2_EXTENSION.lstrip(".")])
    )

    # Create a new environment as we don't want user's configuration as it might
    # not match our default template structure
    template_env = changelog_context.bind_to_environment(
        environment(
            autoescape=False,
            newline_sequence="\n",
            template_dir=tpl_dir,
        )
    )

    # Using the proper enviroment with the changelog context, render the template
    template = template_env.get_template(str(changelog_tpl_file))
    changelog_content = template.render().rstrip()

    # Normalize line endings to ensure universal newlines because that is what is expected
    # of the content when we write it to a file. When using pathlib.Path.write_text(), it
    # will automatically normalize the file to the OS. At this point after render, we may
    # have mixed line endings because of the read_file() call of the previous changelog
    # (which may be /r/n or /n)
    return str.join(
        "\n", [line.replace("\r", "") for line in changelog_content.split("\n")]
    )


def render_release_notes(
    release_notes_template_file: str,
    template_env: Environment,
) -> str:
    # NOTE: release_notes_template_file must be a relative path to the template directory
    # because jinja2's filtering and template loading filter is janky
    template = template_env.get_template(release_notes_template_file)
    release_notes = template.render().rstrip() + os.linesep

    # Normalize line endings to match the current platform
    return str.join(
        os.linesep, [line.replace("\r", "") for line in release_notes.split("\n")]
    )


def apply_user_changelog_template_directory(
    template_dir: Path,
    environment: Environment,
    destination_dir: Path,
    noop: bool = False,
) -> list[str]:
    if noop:
        noop_report(
            str.join(
                " ",
                [
                    "would have recursively rendered the template directory",
                    f"{template_dir!r} relative to {destination_dir!r}.",
                    "Paths which would be modified by this operation cannot be",
                    "determined in no-op mode.",
                ],
            )
        )
        return []

    return recursive_render(
        template_dir, environment=environment, _root_dir=destination_dir
    )


def write_default_changelog(
    changelog_file: Path,
    destination_dir: Path,
    output_format: ChangelogOutputFormat,
    changelog_context: ChangelogContext,
    changelog_style: str,
    noop: bool = False,
) -> str:
    if noop:
        noop_report(
            str.join(
                " ",
                [
                    "would have written your changelog to",
                    str(changelog_file.relative_to(destination_dir)),
                ],
            )
        )
        return str(changelog_file)

    changelog_text = render_default_changelog_file(
        output_format=output_format,
        changelog_context=changelog_context,
        changelog_style=changelog_style,
    )
    # write_text() will automatically normalize newlines to the OS, so we just use an universal newline here
    changelog_file.write_text(f"{changelog_text}\n", encoding="utf-8")

    return str(changelog_file)


def write_changelog_files(
    runtime_ctx: RuntimeContext,
    release_history: ReleaseHistory,
    hvcs_client: HvcsBase,
    noop: bool = False,
) -> list[str]:
    project_dir = Path(runtime_ctx.repo_dir)
    template_dir = runtime_ctx.template_dir

    changelog_context = make_changelog_context(
        hvcs_client=hvcs_client,
        release_history=release_history,
        mode=runtime_ctx.changelog_mode,
        insertion_flag=runtime_ctx.changelog_insertion_flag,
        prev_changelog_file=runtime_ctx.changelog_file,
        mask_initial_release=runtime_ctx.changelog_mask_initial_release,
    )

    user_templates = []

    # Update known templates list if Directory exists and directory has actual files to render
    if template_dir.is_dir():
        user_templates.extend(
            [
                f
                for f in template_dir.rglob("*")
                if f.is_file() and f.suffix == JINJA2_EXTENSION
            ]
        )

        with suppress(ValueError):
            # do not include a release notes override when considering number of changelog templates
            user_templates.remove(template_dir / DEFAULT_RELEASE_NOTES_TPL_FILE)

    # Render user templates if found
    if len(user_templates) > 0:
        return apply_user_changelog_template_directory(
            template_dir=template_dir,
            environment=changelog_context.bind_to_environment(
                runtime_ctx.template_environment
            ),
            destination_dir=project_dir,
            noop=noop,
        )

    logger.info(
        "No contents found in %r, using default changelog template", template_dir
    )
    return [
        write_default_changelog(
            changelog_file=runtime_ctx.changelog_file,
            destination_dir=project_dir,
            output_format=runtime_ctx.changelog_output_format,
            changelog_context=changelog_context,
            changelog_style=runtime_ctx.changelog_style,
            noop=noop,
        )
    ]


def generate_release_notes(
    hvcs_client: HvcsBase,
    release: Release,
    template_dir: Path,
    history: ReleaseHistory,
    style: str,
    mask_initial_release: bool,
    license_name: str = "",
) -> str:
    users_tpl_file = template_dir / DEFAULT_RELEASE_NOTES_TPL_FILE

    # Determine if the user has a custom release notes template or we should use
    # the default template directory with our default release notes template
    tpl_dir = (
        template_dir
        if users_tpl_file.is_file()
        else get_default_tpl_dir(
            style=style, sub_dir=ChangelogOutputFormat.MARKDOWN.value
        )
    )

    release_notes_tpl_file = (
        users_tpl_file.name
        if users_tpl_file.is_file()
        else DEFAULT_RELEASE_NOTES_TPL_FILE
    )

    release_notes_env = ReleaseNotesContext(
        repo_name=hvcs_client.repo_name,
        repo_owner=hvcs_client.owner,
        hvcs_type=hvcs_client.__class__.__name__.lower(),
        version=release["version"],
        release=release,
        mask_initial_release=mask_initial_release,
        license_name=license_name,
        filters=(
            *hvcs_client.get_changelog_context_filters(),
            create_pypi_url,
            autofit_text_width,
            sort_numerically,
        ),
    ).bind_to_environment(
        # Use a new, non-configurable environment for release notes -
        # not user-configurable at the moment
        environment(autoescape=False, template_dir=tpl_dir)
    )

    # TODO: Remove in v11
    release_notes_env.globals["context"] = release_notes_env.globals["ctx"] = {
        "history": history,
        "mask_initial_release": mask_initial_release,
    }

    return render_release_notes(
        release_notes_template_file=release_notes_tpl_file,
        template_env=release_notes_env,
    )