Skip to content

Commit 30e0fa7

Browse files
committed
reference markdown format
1 parent 4a85f0b commit 30e0fa7

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
include LICENSE README.md CONTRIBUTING.md CHANGELOG.rst NOTICES HISTORY.txt
1+
include LICENSE README.md CONTRIBUTING.md CHANGELOG.md NOTICES HISTORY.txt
22
include Makefile pyproject.toml get-pipenv.py *.yml
33
include examples/Pipfil*
44
include *.md

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ mypy_path = "typeshed/pyi:typeshed/imports"
234234

235235
[tool.towncrier]
236236
package = "pipenv"
237-
filename = "CHANGELOG.rst"
237+
filename = "CHANGELOG.md"
238238
issue_format = "`#{issue} <https://github.com/pypa/pipenv/issues/{issue}>`_"
239239
directory = "news/"
240240
title_format = "{version} ({project_date})"

tasks/release.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -96,21 +96,21 @@ def release(
9696
)
9797
tag_content = _render_log()
9898
if dry_run:
99-
ctx.run("towncrier --draft > CHANGELOG.draft.rst")
99+
ctx.run("towncrier --draft > CHANGELOG.draft.md")
100100
log("would remove: news/*")
101-
log("would remove: CHANGELOG.draft.rst")
101+
log("would remove: CHANGELOG.draft.md")
102102
log("would update: pipenv/pipenv.1")
103103
log(f'Would commit with message: "Release v{version}"')
104104
else:
105105
if pre:
106106
log("generating towncrier draft...")
107-
ctx.run("towncrier --draft > CHANGELOG.draft.rst")
107+
ctx.run("towncrier --draft > CHANGELOG.draft.md")
108108
ctx.run(f"git add {get_version_file(ctx).as_posix()}")
109109
else:
110110
ctx.run("towncrier")
111-
ctx.run(f"git add CHANGELOG.rst news/ {get_version_file(ctx).as_posix()}")
111+
ctx.run(f"git add CHANGELOG.md news/ {get_version_file(ctx).as_posix()}")
112112
log("removing changelog draft if present")
113-
draft_changelog = pathlib.Path("CHANGELOG.draft.rst")
113+
draft_changelog = pathlib.Path("CHANGELOG.draft.md")
114114
if draft_changelog.exists():
115115
draft_changelog.unlink()
116116
log("generating man files...")
@@ -188,7 +188,7 @@ def upload_dists(ctx, repo="pypi"):
188188
def generate_markdown(ctx, source_rstfile=None):
189189
log("Generating markdown from changelog...")
190190
if source_rstfile is None:
191-
source_rstfile = "CHANGELOG.rst"
191+
source_rstfile = "CHANGELOG.md"
192192
source_file = pathlib.Path(source_rstfile)
193193
dest_file = source_file.with_suffix(".md")
194194
ctx.run(
@@ -223,13 +223,13 @@ def generate_changelog(ctx, commit=False, draft=False):
223223
if draft:
224224
commit = False
225225
log("Writing draft to file...")
226-
ctx.run("towncrier --draft > CHANGELOG.draft.rst")
226+
ctx.run("towncrier --draft > CHANGELOG.draft.md")
227227
else:
228228
ctx.run("towncrier")
229229
if commit:
230230
log("Committing...")
231-
ctx.run("git add CHANGELOG.rst")
232-
ctx.run("git rm CHANGELOG.draft.rst")
231+
ctx.run("git add CHANGELOG.md")
232+
ctx.run("git rm CHANGELOG.draft.md")
233233
ctx.run('git commit -m "Update changelog."')
234234

235235

0 commit comments

Comments
 (0)