Release Notes Template

Release date: {{RELEASE_DATE}}

{{DEV_DISCLAIMER}}

{{PROJECT_NAME}} {{VERSION}} bundles {{COMMIT_COUNT}} commits from {{CONTRIBUTOR_COUNT}} contributors.

✨ New & Improved

Type Checking

• enhancement 1
• enhancement 2
• enhancement 3

Language Server

• enhancement 1
• enhancement 2
• enhancement 3

{{AREA_3}}

• enhancement 1
• enhancement 2
• enhancement 3

{{AREA_4}}

• enhancement 1
• enhancement 2
• enhancement 3

🐛 Bug fixes

We closed {{NUMBER_OF_ISSUES}} bug issues this release 👏

• #{{GITHUB_ISSUE_NUMBER}}: {{DESCRIBE_BUG_FIX_1}}
• #{{GITHUB_ISSUE_NUMBER}}: {{DESCRIBE_BUG_FIX_2}}
• #{{GITHUB_ISSUE_NUMBER}}: {{DESCRIBE_BUG_FIX_3}}
• And more! #{{GITHUB_ISSUE_NUMBER}}, #{{GITHUB_ISSUE_NUMBER}}, #{{GITHUB_ISSUE_NUMBER}}

Thank-you to all our contributors who found these bugs and reported them! Did you know this is one of the most helpful contributions you can make to an open-source project? If you find any bugs in Pyrefly we want to know about them! Please open a bug report issue here.

📦 Upgrade

pip install --upgrade {{PYPI_PACKAGE_NAME}}=={{VERSION}}

How to safely upgrade your codebase

Upgrading the version of Pyrefly you're using or a third-party library you depend on can reveal new type errors in your code. Fixing them all at once is often unrealistic. We've written scripts to help you temporarily silence them. After upgrading, follow these steps:

1. pyrefly check --suppress-errors
2. Run your code formatter of choice
3. pyrefly check --remove-unused-ignores
4. Repeat until you achieve a clean formatting run and a clean type check.

This will add # pyrefly: ignore comments to your code, enabling you to silence errors and return to fix them later. This can make the process of upgrading a large codebase much more manageable.

Read more about error suppressions in the Pyrefly documentation.

🖊️ Contributors this release

{{CONTRIBUTOR_GITHUB_HANDLES}}

Please note: These release notes summarize major updates and features. For brevity, not all individual commits are listed.