nucypher/newsfragments/validate_files.py

37 lines
761 B
Python

#!/usr/bin/env python3
# Towncrier silently ignores files that do not match the expected ending.
# We use this script to ensure we catch these as errors in CI.
import pathlib
class InvalidNewsFragment(RuntimeError):
pass
ALLOWED_EXTENSIONS = {
'.feature.rst',
'.bugfix.rst',
'.doc.rst',
'.removal.rst',
'.misc.rst',
}
ALLOWED_FILES = {
'validate_files.py',
'README.md',
'.gitignore'
}
THIS_DIR = pathlib.Path(__file__).parent
for fragment_file in THIS_DIR.iterdir():
if fragment_file.name in ALLOWED_FILES:
continue
full_extension = "".join(fragment_file.suffixes)
if full_extension not in ALLOWED_EXTENSIONS:
raise InvalidNewsFragment(f"Unexpected newsfragment file: {fragment_file}")