Conversation
There was a problem hiding this comment.
Pull request overview
This PR migrates the project’s Python linting from flake8/isort to Ruff, updates configuration accordingly, and refactors the changelog renderers to share common rendering logic while adding/adjusting type annotations and docstrings to satisfy the new lint rules.
Changes:
- Replace flake8/isort tox envs with a Ruff tox env and add
ruff.tomlconfiguration. - Remove several dev tooling dependencies (flake8/isort/bandit/etc.) and add Ruff to the dev dependency group.
- Refactor Slack/Teams changelog renderers to use a new shared
render_block_documenthelper and tighten typing/docstrings across code and tests.
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
tox.ini |
Switch tox lint env from flake8/bandit to Ruff; updates GH Actions env mapping. |
ruff.toml |
Adds Ruff lint/format configuration (including import sorting, docstrings, annotations, security rules). |
pyproject.toml |
Updates dev dependencies to include Ruff and removes legacy linters; adds basic mypy config. |
setup.cfg |
Removes flake8 configuration section. |
src/announcer/common.py |
Introduces shared rendering helpers and list utilities used by renderers. |
src/announcer/changelogrenderer.py |
Refactors Slack renderer to use shared helper and adds typing/docstrings. |
src/announcer/teamschangelogrenderer.py |
Refactors Teams renderer to use shared helper and adds typing/docstrings. |
src/announcer/__init__.py |
Updates mistletoe Document usage and improves typing/docstrings. |
tests/test_announce.py |
Reorders imports, adds typing/docstrings, and minor test data fixes. |
tests/test_changelog.py |
Adds module/function docstrings and typing; minor string literal cleanup. |
CONTRIBUTING.md |
Updates contributor instructions to reference Ruff instead of flake8. |
CHANGELOG.md |
Notes the Ruff migration in the Unreleased section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Max Dymond <max.dymond@alianza.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.