diff --git a/scripts/prepare_release.py b/scripts/prepare_release.py index 73ea40f2ff..a1cbea3f5e 100644 --- a/scripts/prepare_release.py +++ b/scripts/prepare_release.py @@ -11,6 +11,8 @@ VERSION_HEADING_PATTERN = re.compile(r"(?m)^## (\d+\.\d+\.\d+)(?: \([^)]+\))?$") RELEASE_NOTES_HEADER = "# Release Notes\n\n" LATEST_CHANGES_HEADER = "## Latest Changes" +AGENT_SKILLS_NOTE = """> Typer includes an official skill that helps coding agents use new features and recommended patterns for your installed version. Install it with `uvx library-skills` in your project. See [Develop with AI](https://typer.tiangolo.com/ai-development/). +""" BumpType = Literal["major", "minor", "patch"] app = typer.Typer() @@ -197,12 +199,10 @@ def release_notes( ], ) -> None: version = get_current_version(version_file.read_text(), version_file) - typer.echo( - get_release_notes_body( - release_notes_file.read_text(), version, release_notes_file - ), - nl=False, + body = get_release_notes_body( + release_notes_file.read_text(), version, release_notes_file ) + typer.echo(f"{AGENT_SKILLS_NOTE}\n{body}", nl=False) if __name__ == "__main__": diff --git a/tests/test_prepare_release.py b/tests/test_prepare_release.py index 024b125466..803f6e2a39 100644 --- a/tests/test_prepare_release.py +++ b/tests/test_prepare_release.py @@ -262,23 +262,33 @@ def test_cli_prints_current_version(tmp_path: Path) -> None: assert result.output == "0.26.2\n" -def test_cli_prints_release_notes(tmp_path: Path) -> None: +def test_cli_prints_release_notes_with_agent_skills_note(tmp_path: Path) -> None: version_file = tmp_path / "package" / "__init__.py" version_file.parent.mkdir() - version_file.write_text('__version__ = "0.26.3"\n') + version_content = '__version__ = "0.26.3"\n' + version_file.write_text(version_content) release_notes_file = tmp_path / "release-notes.md" - release_notes_file.write_text( - """# Release Notes + notes_content = """# Release Notes ## Latest Changes +### Fixes + +* Unreleased fix. + ## 0.26.3 (2026-05-28) ### Fixes * Fix something. + +## 0.26.2 (2026-05-23) + +### Fixes + +* Previous fix. """ - ) + release_notes_file.write_text(notes_content) result = runner.invoke( app, @@ -292,4 +302,11 @@ def test_cli_prints_release_notes(tmp_path: Path) -> None: ) assert result.exit_code == 0, result.output - assert result.output == "### Fixes\n\n* Fix something.\n" + note, separator, body = result.output.partition("\n\n") + assert note.startswith("> Typer includes an official skill") + assert note.count("`uvx library-skills`") == 1 + assert "[Develop with AI](https://typer.tiangolo.com/ai-development/)" in note + assert separator + assert body == "### Fixes\n\n* Fix something.\n" + assert release_notes_file.read_text() == notes_content + assert version_file.read_text() == version_content