Refactor in response to review

- Change `build_ignore_filenames` to `ignore` in config
- Remove `--strict` option from `towncrier build`

Author: MetRonnie

docs/cli.rst

@@ -64,11 +64,6 @@ also remove the fragments directory if now empty.
 
    Don't delete news fragments after the build and don't ask for confirmation whether to delete or keep the fragments.
 
-.. option:: --strict
-
-   Fail if there are any news fragments that have invalid filenames.
-   This is automatically turned on if ``build_ignore_filenames`` has been set in the configuration.
-
 
 ``towncrier create``
 --------------------

docs/configuration.rst

@@ -130,10 +130,12 @@ Top level keys
 
     ``true`` by default.
 
-``build_ignore_filenames``
-    A list of filenames in the news fragments directory to ignore when building the news file.
+``ignore``
+    A list of filenames in the news fragments directory to ignore.
 
-    If this is configured, it turns on the ``--strict`` build mode which will fail if there are any news fragment files not in this list that have invalid filenames. Note that if a template is used, it should also be included here.
+    ``towncrier check`` will fail if there are any news fragment files that have invalid filenames, except for those in the list. ``towncrier build`` will likewise fail, but only if this list has been configured (set to an empty list if there are no files to ignore).
+
+    Note that if a custom template is stored in the news fragment directory, you should add it to this list.
 
     ``None`` by default.
 

docs/tutorial.rst

@@ -47,11 +47,6 @@ Create this folder::
 
 The ``.gitignore`` will remain and keep Git from not tracking the directory.
 
-If needed, you can also specify a list of filenames for ``towncrier`` to ignore in the news fragments directory::
-
-   [tool.towncrier]
-   build_ignore_filenames = ["README.rst"]
-
 
 Detecting Version
 -----------------

src/towncrier/_builder.py

@@ -107,21 +107,16 @@ def __call__(self, section_directory: str = "") -> str:
 def find_fragments(
     base_directory: str,
     config: Config,
-    strict: bool | None,
+    strict: bool,
 ) -> tuple[Mapping[str, Mapping[tuple[str, str, int], str]], list[tuple[str, str]]]:
     """
     Sections are a dictonary of section names to paths.
 
-    In strict mode, raise ClickException if any fragments have an invalid name.
+    If strict, raise ClickException if any fragments have an invalid name.
     """
-    if strict is None:
-        # If strict mode is not set, turn it on only if build_ignore_filenames is set
-        # (this maintains backward compatibility).
-        strict = config.build_ignore_filenames is not None
-
     ignored_files = {".gitignore"}
-    if config.build_ignore_filenames:
-        ignored_files.update(config.build_ignore_filenames)
+    if config.ignore:
+        ignored_files.update(config.ignore)
 
     get_section_path = FragmentsPath(base_directory, config)
 
@@ -142,7 +137,6 @@ def find_fragments(
         file_content = {}
 
         for basename in files:
-            # Skip files that are deliberately ignored
             if basename in ignored_files:
                 continue
 
@@ -154,7 +148,7 @@ def find_fragments(
                     raise ClickException(
                         f"Invalid news fragment name: {basename}\n"
                         "If this filename is deliberate, add it to "
-                        "'build_ignore_filenames' in your configuration."
+                        "'ignore' in your configuration."
                     )
                 continue
             assert issue is not None

src/towncrier/_settings/load.py

@@ -54,7 +54,7 @@ class Config:
     orphan_prefix: str = "+"
     create_eof_newline: bool = True
     create_add_extension: bool = True
-    build_ignore_filenames: list[str] | None = None
+    ignore: list[str] | None = None
 
 
 class ConfigError(ClickException):

src/towncrier/build.py

@@ -106,17 +106,6 @@ def _validate_answer(ctx: Context, param: Option, value: bool) -> bool:
     help="Do not ask for confirmations. But keep news fragments.",
     callback=_validate_answer,
 )
-@click.option(
-    "--strict",
-    "strict",
-    default=None,
-    flag_value=True,
-    help=(
-        "Fail if there are any news fragments that have invalid filenames (this is "
-        "automatically turned on if 'build_ignore_filenames' has been set in the "
-        "configuration)."
-    ),
-)
 def _main(
     draft: bool,
     directory: str | None,
@@ -126,7 +115,6 @@ def _main(
     project_date: str | None,
     answer_yes: bool,
     answer_keep: bool,
-    strict: bool | None,
 ) -> None:
     """
     Build a combined news file from news fragment.
@@ -141,7 +129,6 @@ def _main(
             project_date,
             answer_yes,
             answer_keep,
-            strict,
         )
     except ConfigError as e:
         print(e, file=sys.stderr)
@@ -157,7 +144,6 @@ def __main(
     project_date: str | None,
     answer_yes: bool,
     answer_keep: bool,
-    strict: bool | None,
 ) -> None:
     """
     The main entry point.
@@ -192,7 +178,13 @@ def __main(
 
     click.echo("Finding news fragments...", err=to_err)
 
-    fragment_contents, fragment_files = find_fragments(base_directory, config, strict)
+    fragment_contents, fragment_files = find_fragments(
+        base_directory,
+        config,
+        # Fail if any fragment filenames are invalid only if ignore list is set
+        # (this maintains backward compatibility):
+        strict=(config.ignore is not None),
+    )
     fragment_filenames = [filename for (filename, _category) in fragment_files]
 
     click.echo("Rendering news fragments...", err=to_err)

src/towncrier/newsfragments/622.feature.rst

@@ -1,3 +1,3 @@
 ``towncrier check`` will now fail if any news fragments have invalid filenames.
 
-Added a new configuration option called ``build_ignore_filenames`` that allows you to specify a list of filenames that should be ignored. If this is set, ``towncrier build`` will also fail if any filenames are invalid, except for those in the list.
+Added a new configuration option called ``ignore`` that allows you to specify a list of filenames that should be ignored. If this is set, ``towncrier build`` will also fail if any filenames are invalid, except for those in the list.

src/towncrier/test/test_build.py

@@ -1535,55 +1535,61 @@ def test_orphans_in_non_showcontent_markdown(self, runner):
         config="""
         [tool.towncrier]
         package = "foo"
-        build_ignore_filenames = ["template.jinja", "CAPYBARAS.md"]
+        ignore = ["template.jinja", "CAPYBARAS.md"]
         """
     )
-    def test_invalid_fragment_names(self, runner):
+    def test_ignored_files(self, runner):
         """
-        When build_ignore_filenames is set, files with those names are ignored.
+        When `ignore` is set in config, files with those names are ignored.
         """
-        opts = ["--draft", "--date", "01-01-2001", "--version", "1.0.0"]
-        # Valid filename:
         with open("foo/newsfragments/123.feature", "w") as f:
-            f.write("Adds levitation")
-        # Files that should be ignored:
+            f.write("This has valid filename (control case)")
         with open("foo/newsfragments/template.jinja", "w") as f:
-            f.write("Jinja template")
+            f.write("This template has been manually ignored")
         with open("foo/newsfragments/CAPYBARAS.md", "w") as f:
-            f.write("Peanut butter")
-        # Automatically ignored:
+            f.write("This markdown file has been manually ignored")
         with open("foo/newsfragments/.gitignore", "w") as f:
-            f.write("!.gitignore")
+            f.write("gitignore is automatically ignored")
 
-        result = runner.invoke(_main, opts)
-        # Should succeed
+        result = runner.invoke(
+            _main, ["--draft", "--date", "01-01-2001", "--version", "1.0.0"]
+        )
         self.assertEqual(0, result.exit_code, result.output)
 
-        # Invalid filename:
+    @with_project(
+        config="""
+        [tool.towncrier]
+        package = "foo"
+        ignore = []
+        """
+    )
+    def test_invalid_fragment_name(self, runner):
+        """
+        When `ignore` is set in config, invalid filenames cause failure.
+        """
+        with open("foo/newsfragments/123.feature", "w") as f:
+            f.write("This has valid filename (control case)")
         with open("foo/newsfragments/feature.124", "w") as f:
-            f.write("Extends levitation")
+            f.write("This has the issue and category the wrong way round")
 
-        result = runner.invoke(_main, opts)
-        # Should now fail
+        result = runner.invoke(
+            _main, ["--draft", "--date", "01-01-2001", "--version", "1.0.0"]
+        )
         self.assertEqual(1, result.exit_code, result.output)
         self.assertIn("Invalid news fragment name: feature.124", result.output)
 
     @with_project()
-    def test_invalid_fragment_names_strict(self, runner):
+    def test_no_ignore_configured(self, runner):
         """
-        When using --strict, any invalid filenames will cause an error even if
-        build_ignore_filenames is NOT set.
+        When `ignore` is not set in config, invalid filenames are skipped.
+
+        This maintains backward compatibility with before we added `ignore`
+        to the configuration spec.
         """
-        opts = ["--draft", "--date", "01-01-2001", "--version", "1.0.0"]
-        # Invalid filename:
         with open("foo/newsfragments/feature.124", "w") as f:
-            f.write("Extends levitation")
+            f.write("This has the issue and category the wrong way round")
 
-        result = runner.invoke(_main, opts)
-        # Should succeed in normal mode
+        result = runner.invoke(
+            _main, ["--draft", "--date", "01-01-2001", "--version", "1.0.0"]
+        )
         self.assertEqual(0, result.exit_code, result.output)
-
-        result = runner.invoke(_main, [*opts, "--strict"])
-        # Should now fail
-        self.assertEqual(1, result.exit_code, result.output)
-        self.assertIn("Invalid news fragment name: feature.124", result.output)

src/towncrier/test/test_check.py

@@ -472,21 +472,41 @@ def test_in_different_dir_with_nondefault_newsfragments_directory(self, runner):
         )
 
     @with_isolated_runner
-    def test_invalid_fragment_name(self, runner):
-        create_project("pyproject.toml")
-        opts = ["--compare-with", "main"]
+    def test_ignored_files(self, runner):
+        """
+        When `ignore` is set in config, files with those names are ignored.
+        """
+        create_project("pyproject.toml", extra_config='ignore = ["template.jinja"]')
 
-        write("foo/bar.py", "# Scorpions!")
-        write("foo/newsfragments/123.feature", "Adds scorpions")
-        write("foo/newsfragments/.gitignore", "!.gitignore")
+        write(
+            "foo/newsfragments/123.feature",
+            "This fragment has valid name (control case)",
+        )
+        write("foo/newsfragments/template.jinja", "This is manually ignored")
+        write("foo/newsfragments/.gitignore", "gitignore is automatically ignored")
         commit("add stuff")
 
-        result = runner.invoke(towncrier_check, opts)
+        result = runner.invoke(towncrier_check, ["--compare-with", "main"])
         self.assertEqual(0, result.exit_code, result.output)
 
-        # Make invalid filename:
-        os.rename("foo/newsfragments/123.feature", "foo/newsfragments/feature.123")
+    @with_isolated_runner
+    def test_invalid_fragment_name(self, runner):
+        """
+        Fails if a news fragment has an invalid name, even if `ignore` is not set in
+        the config.
+        """
+        create_project("pyproject.toml")
+
+        write(
+            "foo/newsfragments/123.feature",
+            "This fragment has valid name (control case)",
+        )
+        write(
+            "foo/newsfragments/feature.124",
+            "This has issue and category wrong way round",
+        )
+        commit("add stuff")
 
-        result = runner.invoke(towncrier_check, opts)
+        result = runner.invoke(towncrier_check, ["--compare-with", "main"])
         self.assertEqual(1, result.exit_code, result.output)
-        self.assertIn("Invalid news fragment name: feature.123", result.output)
+        self.assertIn("Invalid news fragment name: feature.124", result.output)