Skip to content

Commit

Permalink
Add internal type for release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
carver authored and cburgdorf committed Nov 25, 2019
1 parent 07eecb5 commit 89363b2
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 8 deletions.
3 changes: 2 additions & 1 deletion newsfragments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Each file should be named like `<ISSUE>.<TYPE>.rst`, where
* `bugfix`
* `performance`
* `doc`
* `internal`
* `removal`
* `misc`

Expand All @@ -23,4 +24,4 @@ then open up the PR first and use the PR number for the newsfragment.
Note that the `towncrier` tool will automatically
reflow your text, so don't try to do any fancy formatting. Run
`towncrier --draft` to get a preview of what the release notes entry
will look like in the final release notes.
will look like in the final release notes.
17 changes: 14 additions & 3 deletions newsfragments/validate_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@

import os
import pathlib
import sys

ALLOWED_EXTENSIONS = {
'.bugfix.rst',
'.doc.rst',
'.feature.rst',
'.internal.rst',
'.misc.rst',
'.performance.rst',
'.removal.rst',
Expand All @@ -22,11 +24,20 @@

THIS_DIR = pathlib.Path(__file__).parent

num_args = len(sys.argv) - 1
assert num_args in {0, 1}
if num_args == 1:
assert sys.argv[1] in ('is-empty', )

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:
elif num_args == 0:
full_extension = "".join(fragment_file.suffixes)
if full_extension not in ALLOWED_EXTENSIONS:
raise Exception(f"Unexpected file: {fragment_file}")
elif sys.argv[1] == 'is-empty':
raise Exception(f"Unexpected file: {fragment_file}")
else:
raise RuntimeError("Strange: arguments {sys.argv} were validated, but not found")
11 changes: 7 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ directory = "newsfragments"
underlines = ["-", "~", "^"]
issue_format = "`#{issue} <https://github.com/ethereum/<REPO_NAME>/issues/{issue}>`__"

# Configure all default sections plus an extra one for performance improvements.

[[tool.towncrier.type]]
directory = "feature"
name = "Features"
Expand All @@ -33,7 +31,12 @@ directory = "removal"
name = "Deprecations and Removals"
showcontent = true

[[tool.towncrier.type]]
directory = "internal"
name = "Internal Changes - for <PROJECT_NAME> Contributors"
showcontent = true

[[tool.towncrier.type]]
directory = "misc"
name = "Miscellaneous internal changes"
showcontent = false
name = "Miscellaneous changes"
showcontent = false

0 comments on commit 89363b2

Please sign in to comment.