Renamed render to render_changelog for clarity

Author: coordt

generate_changelog/cli.py

@@ -89,7 +89,7 @@ def main(
 
     # use the output pipeline to deal with the rendered change log.
     output_pipeline = pipeline_factory(config.output_pipeline, **config.variables)
-    output_pipeline.run(templating.render(repository, config, starting_tag))
+    output_pipeline.run(templating.render_changelog(repository, config, starting_tag))
     typer.echo("Done.")
     raise typer.Exit()
 

generate_changelog/templating.py

@@ -33,7 +33,7 @@ def get_pipeline_env(config: Optional[Configuration] = None):
     )
 
 
-def render(repository: Repo, config: Configuration, starting_tag: Optional[str] = None) -> str:
+def render_changelog(repository: Repo, config: Configuration, starting_tag: Optional[str] = None) -> str:
     """
     Render the full or incremental changelog for the repository to a string.
 

test/test_conv_commits.py

@@ -272,6 +272,6 @@ def test_conventional_commits(conv_commit_repo):
     config.update_from_file(config_file_path)
     config.template_dirs = []
 
-    output = templating.render(conv_commit_repo, config, None)
+    output = templating.render_changelog(conv_commit_repo, config, None)
     expected = (FIXTURES_DIR / "rendered_conv_commit_repo.md").read_text()
     assert output.strip() == expected.strip()

test/test_templating.py

@@ -104,7 +104,7 @@ def test_render(default_repo, capsys):
     """Render should render the changelog."""
     config = configuration.get_default_config()
     config.template_dirs = []
-    output = templating.render(default_repo, config, None)
+    output = templating.render_changelog(default_repo, config, None)
     expected = (FIXTURES_DIR / "rendered_default_repo.md").read_text()
     assert output.strip() == expected.strip()
 
@@ -113,7 +113,7 @@ def test_render_from_tag(default_repo, capsys):
     """Render should render the changelog."""
     config = configuration.get_default_config()
     config.template_dirs = []
-    output = templating.render(default_repo, config, "0.0.3")
+    output = templating.render_changelog(default_repo, config, "0.0.3")
     expected = textwrap.dedent(
         """
         # Changelog
@@ -133,7 +133,7 @@ def test_incremental_context(default_repo, capsys):
     """Make sure the incremental changelog includes the previous version."""
     config = configuration.get_default_config()
     config.template_dirs = [FIXTURES_DIR / "templates"]
-    output = templating.render(default_repo, config, "0.0.2")
+    output = templating.render_changelog(default_repo, config, "0.0.2")
     expected = textwrap.dedent(
         """
         # Changelog