Ignore types on check

docs/configuration.rst

@@ -221,6 +221,11 @@ These may include the following optional keys:
         Orphan fragments (those without an issue number) always have their content included.
         If a fragment was created, it means that information is important for end users.
 
+``check``
+    A boolean value indicating whether the fragment should be considered by the ``towncrier check`` command.
+
+    ``true`` by default.
+
 For example, if you want your custom fragment types to be ``["feat", "fix", "chore",]`` and you want all of them to use the default configuration except ``"chore"`` you can do it as follows:
 
 .. code-block:: toml
@@ -234,6 +239,10 @@ For example, if you want your custom fragment types to be ``["feat", "fix", "cho
    name = "Other Tasks"
    showcontent = false
 
+   [tool.towncrier.fragment.auto]
+   name = "Automatic Changes"
+   check = false
+
 
 .. warning::
 
@@ -267,6 +276,11 @@ Each table within this array has the following mandatory keys:
         Orphan fragments (those without an issue number) always have their content included.
         If a fragment was created, it means that information is important for end users.
 
+``check``
+    A boolean value indicating whether the fragment should be considered by the ``towncrier check`` command.
+
+    ``true`` by default.
+
 For example:
 
 .. code-block:: toml
@@ -281,3 +295,9 @@ For example:
    directory = "chore"
    name = "Other Tasks"
    showcontent = false
+
+   [[tool.towncrier.type]]
+   directory = "auto"
+   name = "Automatic Changes"
+   showcontent = true
+   check = false

src/towncrier/_builder.py

@@ -89,11 +89,11 @@ def __call__(self, section_directory: str = "") -> str:
 #
 # {
 #     "": {
-#         ("142", "misc"): "",
-#         ("1", "feature"): "some cool description",
+#         ("142", "misc", 1): "",
+#         ("1", "feature", 1): "some cool description",
 #     },
 #     "Names": {},
-#     "Web": {("3", "bugfix"): "Fixed a thing"},
+#     "Web": {("3", "bugfix", 1): "Fixed a thing"},
 # }
 #
 # We should really use attrs.
@@ -102,6 +102,7 @@ def __call__(self, section_directory: str = "") -> str:
 def find_fragments(
     base_directory: str,
     config: Config,
+    only_check_categories: bool = False,
 ) -> tuple[Mapping[str, Mapping[tuple[str, str, int], str]], list[str]]:
     """
     Sections are a dictonary of section names to paths.
@@ -130,6 +131,8 @@ def find_fragments(
             )
             if category is None:
                 continue
+            if only_check_categories and config.types[category]["check"] is False:
+                continue
             assert issue is not None
             assert counter is not None
             if config.orphan_prefix and issue.startswith(config.orphan_prefix):

src/towncrier/_settings/fragment_types.py

@@ -37,11 +37,15 @@ class DefaultFragmentTypesLoader(BaseFragmentTypesLoader):
 
     _default_types = {
         # Keep in-sync with docs/tutorial.rst.
-        "feature": {"name": "Features", "showcontent": True},
-        "bugfix": {"name": "Bugfixes", "showcontent": True},
-        "doc": {"name": "Improved Documentation", "showcontent": True},
-        "removal": {"name": "Deprecations and Removals", "showcontent": True},
-        "misc": {"name": "Misc", "showcontent": False},
+        "feature": {"name": "Features", "showcontent": True, "check": True},
+        "bugfix": {"name": "Bugfixes", "showcontent": True, "check": True},
+        "doc": {"name": "Improved Documentation", "showcontent": True, "check": True},
+        "removal": {
+            "name": "Deprecations and Removals",
+            "showcontent": True,
+            "check": True,
+        },
+        "misc": {"name": "Misc", "showcontent": False, "check": True},
     }
 
     def load(self) -> Mapping[str, Mapping[str, Any]]:
@@ -75,9 +79,11 @@ def load(self) -> Mapping[str, Mapping[str, Any]]:
             directory = type_config["directory"]
             fragment_type_name = type_config["name"]
             is_content_required = type_config["showcontent"]
+            check = type_config.get("check", True)
             types[directory] = {
                 "name": fragment_type_name,
                 "showcontent": is_content_required,
+                "check": check,
             }
         return types
 
@@ -129,8 +135,10 @@ def _load_options(self, fragment_type: str) -> Mapping[str, Any]:
         options = self.fragment_options.get(fragment_type, {})
         fragment_description = options.get("name", capitalized_fragment_type)
         show_content = options.get("showcontent", True)
+        check = options.get("check", True)
         clean_fragment_options = {
             "name": fragment_description,
             "showcontent": show_content,
+            "check": check,
         }
         return clean_fragment_options

src/towncrier/check.py

@@ -107,7 +107,10 @@ def __main(
         sys.exit(0)
 
     fragments = {
-        os.path.abspath(path) for path in find_fragments(base_directory, config)[1]
+        os.path.abspath(path)
+        for path in find_fragments(base_directory, config, only_check_categories=True)[
+            1
+        ]
     }
     fragments_in_branch = fragments & files
 

src/towncrier/newsfragments/617.feature.rst

@@ -0,0 +1 @@
+newsfragment categories can now be marked with ``check = false``, causing them to be ignored in ``towncrier check``

src/towncrier/test/test_check.py

@@ -166,6 +166,71 @@ def test_fragment_missing(self):
                 result.output.endswith("No new newsfragments found on this branch.\n")
             )
 
+    def test_fragment_exists_but_not_in_check(self):
+        runner = CliRunner()
+
+        with runner.isolated_filesystem():
+            create_project(
+                "pyproject.toml",
+                main_branch="master",
+                extra_config="[[tool.towncrier.type]]\n"
+                'directory = "feature"\n'
+                'name = "Features"\n'
+                "showcontent = true\n"
+                "[[tool.towncrier.type]]\n"
+                'directory = "auto"\n'
+                'name = "Automatic"\n'
+                "showcontent = true\n"
+                "check=false\n",
+            )
+
+            file_path = "foo/somefile.py"
+            write(file_path, "import os")
+
+            fragment_path = Path("foo/newsfragments/1234.auto").absolute()
+            write(fragment_path, "Adds gravity back")
+            commit("add a file and a newsfragment")
+
+            result = runner.invoke(towncrier_check, ["--compare-with", "master"])
+
+            self.assertEqual(1, result.exit_code)
+            self.assertTrue(
+                result.output.endswith("No new newsfragments found on this branch.\n")
+            )
+
+    def test_fragment_exists_but_in_check(self):
+        runner = CliRunner()
+
+        with runner.isolated_filesystem():
+            create_project(
+                "pyproject.toml",
+                main_branch="master",
+                extra_config="[[tool.towncrier.type]]\n"
+                'directory = "feature"\n'
+                'name = "Features"\n'
+                "showcontent = true\n"
+                "[[tool.towncrier.type]]\n"
+                'directory = "auto"\n'
+                'name = "Automatic"\n'
+                "showcontent = true\n"
+                "check=false\n",
+            )
+
+            file_path = "foo/somefile.py"
+            write(file_path, "import os")
+
+            fragment_path = Path("foo/newsfragments/1234.feature").absolute()
+            write(fragment_path, "Adds gravity back")
+            commit("add a file and a newsfragment")
+
+            result = runner.invoke(towncrier_check, ["--compare-with", "master"])
+
+            self.assertEqual(0, result.exit_code)
+            self.assertTrue(
+                result.output.endswith("Found:\n1. " + str(fragment_path) + "\n"),
+                (result.output, str(fragment_path)),
+            )
+
     def test_none_stdout_encoding_works(self):
         """
         No failure when output is piped causing None encoding for stdout.

src/towncrier/test/test_settings.py

@@ -288,6 +288,12 @@ def test_custom_types_as_tables_array_deprecated(self):
                 directory="spam"
                 name="Spam"
                 showcontent=true
+
+                [[tool.towncrier.type]]
+                directory="auto"
+                name="Automatic"
+                showcontent=true
+                check=false
             """
         )
         config = load_config(project_dir)
@@ -297,13 +303,23 @@ def test_custom_types_as_tables_array_deprecated(self):
                 {
                     "name": "Foo",
                     "showcontent": False,
+                    "check": True,
                 },
             ),
             (
                 "spam",
                 {
                     "name": "Spam",
                     "showcontent": True,
+                    "check": True,
+                },
+            ),
+            (
+                "auto",
+                {
+                    "name": "Automatic",
+                    "showcontent": True,
+                    "check": False,
                 },
             ),
         ]
@@ -326,21 +342,32 @@ def test_custom_types_as_tables(self):
                 [tool.towncrier.fragment.chore]
                 name = "Other Tasks"
                 showcontent = false
+                [tool.towncrier.fragment.auto]
+                name = "Automatic"
+                check = false
             """
         )
         config = load_config(project_dir)
         expected = {
             "chore": {
                 "name": "Other Tasks",
                 "showcontent": False,
+                "check": True,
             },
             "feat": {
                 "name": "Feat",
                 "showcontent": True,
+                "check": True,
             },
             "fix": {
                 "name": "Fix",
                 "showcontent": True,
+                "check": True,
+            },
+            "auto": {
+                "name": "Automatic",
+                "showcontent": True,
+                "check": False,
             },
         }
         actual = config.types