From d505a6d2c29dd02144609f53a855866cd7d0acf2 Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Fri, 6 Mar 2026 13:39:22 -0600 Subject: [PATCH 1/7] copilot generated changelog --- CHANGELOG.md | 285 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 285 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0339629 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,285 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [0.4.9] - 2025-02-03 + +### Fixed +- Work around "No module named 'pkg_resources'" by pinning setuptools to <82 (#275) + +## [0.4.8] - 2025-01-23 + +### Fixed +- Pin black to version that supports Python < 3.10 still (#262) + +### Changed +- Update project version (#230) + +## [0.4.7] - 2025-07-10 + +No changes documented for this release. + +## [0.4.6] - 2024-06-12 + +### Fixed +- Fix command being over aggressive (#185) +- Bump the patch version number (#184) + +### Added +- Ignore documentation errors in Sphinx config (#183) + +### Security +- Bump nokogiri from 1.16.2 to 1.16.5 in /docs (#180) +- Bump rexml from 3.2.5 to 3.2.8 in /docs (#181) + +## [0.4.5] - 2024-05-02 + +### Added +- Add `nps` as short command (#154) +- Ignore F401 for init.py files (#173) + +### Changed +- Remove 3.7 testing (#179) +- Remove @rtzoeller from notification list (#178) + +### Security +- Bump nokogiri from 1.14.3 to 1.16.2 in /docs (#163) + +## [0.4.4] - 2023-10-17 + +### Added +- Also ignore D102 Missing docstring in public method in tests (#148) + +### Changed +- Update poetry lock and reformat (#147) + +## [0.4.3] - 2023-10-13 + +### Added +- Also allow flat tests to ignore missing docstrings (#146) + +## [0.4.2] - 2023-10-10 + +### Added +- Add support for Python 3.12 (#143) +- Document fix subcommand (#127) + +### Changed +- Update poetry lock and reformat (#144) +- Bump package patch version since last release did not (#145) +- Use native gh tooling to raise pr (#138) +- Switch the pat used to create the PR to enable PR checks (#140) +- Update lock poetry version (#130) +- Enable running lock action on demand (#131) +- Testing if this makes PRs run checks (#135) + +## [0.4.1] - 2023-04-27 + +### Added +- Ignore missing docstrings in methods in "tests" dir "test_*.py" (#120) +- Adding documentation about BLK100 issue in D.1.12, add Visual Studio dir to .gitignore (#117) + +### Changed +- Remove D.1.12 from Coding-Conventions, bump black min version to 23.1 (#119) +- Add check to skip update poetry lock action on forks (#108) + +### Fixed +- Fix acknowledge comments (#126) + +### Security +- Bump activesupport from 6.0.4.6 to 6.0.6.1 in /docs (#105) +- Bump nokogiri from 1.13.10 to 1.14.3 in /docs (#123) + +## [0.4.0] - 2023-01-20 + +### Added +- Recommend Google Style for DocStrings (#88) + +### Fixed +- Fix comments (#101) +- Fix no split submodule imports (#102) + +### Changed +- Update Poetry Lock (#100) + +## [0.3.0] - 2023-01-09 + +### Changed +- Bump flake8 to 5.x (#98) +- Fix up tooling (#99) + +## [0.2.0] - 2022-12-08 + +### Changed +- Drop 3.6 support (#96) +- Disallow black 22.10.0 because the initial macOS wheels had the wrong architecture (#95) +- Remove `alexweav` from bot @-mention list (#91) + +### Security +- Bump nokogiri from 1.13.6 to 1.13.9 in /docs (#93) +- Bump nokogiri from 1.13.9 to 1.13.10 in /docs (#94) + +## [0.1.17] - 2023-10-12 + +Testing release pipeline + +## [0.1.15] - 2023-10-10 + +### Changed +- Cherry-pick explicitly recommending Google style + +## [0.1.14.4] - 2023-10-09 + +### Changed +- Cherry-pick: Tests may skip doc-strings + +## [0.1.13] - 2022-10-12 + +### Fixed +- Pin importlib-metadata for python 3.7 and under (#92) + +### Changed +- Use black profile with isort to reduce manual work (#87) +- Change pr commenter tooling (#89) +- Add tkrebes to tag list for convention changes (#90) + +### Security +- Bump nokogiri from 1.13.4 to 1.13.6 in /docs (#85) +- Bump tzinfo from 1.2.9 to 1.2.10 in /docs (#86) + +## [0.1.12] - 2022-05-09 + +### Fixed +- Fix bug in "fix --aggressive" (#84) + +## [0.1.11] - 2022-05-02 + +### Added +- Add fix command (#80) + +### Changed +- Refactor linting utilities to own submodule (#82) + +### Security +- Bump nokogiri from 1.12.5 to 1.13.3 in /docs (#78) +- Update Gemfile.lock (#79) +- Bump nokogiri from 1.13.3 to 1.13.4 in /docs (#81) + +## [0.1.10] - 2022-02-03 + +### Changed +- Treat global mutables as global vars (#75) +- Be more lenient on dependency versioning by using >= (#77) + +## [0.1.9] - 2021-11-17 + +### Fixed +- Fix some acknowledge corner cases (#74) + +## [0.1.8] - 2021-11-15 + +### Added +- Add --aggressive flag to acknowledge subcommand (#72) + +### Changed +- Change links to fully qualified (#48) +- Run PR on multiplatform and multi Python version (#53) +- Document Release Instructions (#54) +- Update README.md (#56) +- Update pipeline templates (#59) +- Fix #55 by using smarkets style (#57) +- Improve multiline statement handling (#67) +- Update deps (#73) + +### Fixed +- Avoid index errors when input file is empty (#66) +- Suppression handle unicode files (#69) +- Better handle when acknowledging violations will cause reformat (#72) +- Coding-Conventions.md: fix 404 for black (#71) + +### Security +- Bump nokogiri from 1.11.1 to 1.11.5 in /docs (#62) +- Bump rexml from 3.2.4 to 3.2.5 in /docs (#61) +- Bump addressable from 2.7.0 to 2.8.0 in /docs (#63) +- Bump nokogiri from 1.11.1 to 1.12.5 in /docs (#68) + +## [0.1.7.0] - 2021-10-20 + +Release pipeline was broken, retrigger push to pypi.org + +## [0.1.6.0] - 2021-10-20 + +### Fixed +- Default acknowledge script to using UTF-8 encoding on source files (#69) + +## [0.1.5.1] - 2021-09-08 + +### Fixed +- Fix auto-suppression handling blank files (#66) + +## [0.1.5.0] - 2021-02-12 + +### Added +- Add flake8-import-order to rules being evaluated (#49) +- Add hacking to rejected plugins (#50) +- Reject flake8-commas (#51) +- Reject flake8-isort (#52) + +## [0.1.4] - 2021-02-02 + +### Added +- Add acknowledge-existing-errors command to allow for easy adoption or upgrade to newest version + +## [0.1.3] - 2021-02-01 + +### Added +- Add pep8-naming plugin + +## [0.1.2] - 2021-01-07 + +### Changed +- Use admin PAT to bypass checks when bumping Poetry version (#39) + +## [0.1.1] - 2021-01-06 + +### Changed +- Bump the package version to 0.1.0-alpha since the 0.1.0 release already exists + +## [0.1.0] - 2021-01-06 + +### Added +- Initial Release 🚀 + +[0.4.9]: https://github.com/ni/python-styleguide/compare/v0.4.8...v0.4.9 +[0.4.8]: https://github.com/ni/python-styleguide/compare/v0.4.7...v0.4.8 +[0.4.7]: https://github.com/ni/python-styleguide/compare/v0.4.6...v0.4.7 +[0.4.6]: https://github.com/ni/python-styleguide/compare/v0.4.5...v0.4.6 +[0.4.5]: https://github.com/ni/python-styleguide/compare/v0.4.4...v0.4.5 +[0.4.4]: https://github.com/ni/python-styleguide/compare/v0.4.3...v0.4.4 +[0.4.3]: https://github.com/ni/python-styleguide/compare/v0.4.2...v0.4.3 +[0.4.2]: https://github.com/ni/python-styleguide/compare/v0.4.1...v0.4.2 +[0.4.1]: https://github.com/ni/python-styleguide/compare/v0.4.0...v0.4.1 +[0.4.0]: https://github.com/ni/python-styleguide/compare/v0.3.0...v0.4.0 +[0.3.0]: https://github.com/ni/python-styleguide/compare/v0.2.0...v0.3.0 +[0.2.0]: https://github.com/ni/python-styleguide/compare/v0.1.13...v0.2.0 +[0.1.17]: https://github.com/ni/python-styleguide/compare/v0.1.15...v0.1.17 +[0.1.15]: https://github.com/ni/python-styleguide/compare/v0.1.14.4...v0.1.15 +[0.1.14.4]: https://github.com/ni/python-styleguide/compare/v0.1.13...v0.1.14.4 +[0.1.13]: https://github.com/ni/python-styleguide/compare/v0.1.12...v0.1.13 +[0.1.12]: https://github.com/ni/python-styleguide/compare/v0.1.11...v0.1.12 +[0.1.11]: https://github.com/ni/python-styleguide/compare/v0.1.10...v0.1.11 +[0.1.10]: https://github.com/ni/python-styleguide/compare/v0.1.9...v0.1.10 +[0.1.9]: https://github.com/ni/python-styleguide/compare/v0.1.8...v0.1.9 +[0.1.8]: https://github.com/ni/python-styleguide/compare/0.1.4...v0.1.8 +[0.1.7.0]: https://github.com/ni/python-styleguide/compare/0.1.4...0.1.7.0 +[0.1.6.0]: https://github.com/ni/python-styleguide/compare/0.1.5.1...0.1.6.0 +[0.1.5.1]: https://github.com/ni/python-styleguide/compare/0.1.5.0...0.1.5.1 +[0.1.5.0]: https://github.com/ni/python-styleguide/compare/0.1.4...0.1.5.0 +[0.1.4]: https://github.com/ni/python-styleguide/compare/0.1.3...0.1.4 +[0.1.3]: https://github.com/ni/python-styleguide/compare/v0.1.2...0.1.3 +[0.1.2]: https://github.com/ni/python-styleguide/compare/v0.1.1...v0.1.2 +[0.1.1]: https://github.com/ni/python-styleguide/compare/v0.1.0...v0.1.1 +[0.1.0]: https://github.com/ni/python-styleguide/releases/tag/v0.1.0 From a28eaaddd48c6d90781c6f39b6c2e2d34c85ecce Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Fri, 6 Mar 2026 13:42:29 -0600 Subject: [PATCH 2/7] add TOC and have copilot add the unreleased section --- CHANGELOG.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0339629..046f892 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,5 @@ +[[_TOC_]] + # Changelog All notable changes to this project will be documented in this file. @@ -5,6 +7,45 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### Added +- Add vim/neovim integration instructions to README (#205) +- Adopt flake8-tidy-imports to enforce O.1.5 (#223) +- Add fallbacks to `_get_application_import_names` (#234) + +### Changed +- Drop Python 3.7 support (#218) +- Bump black from 23.3.0 to 24.3.0 (#220) +- Bump setuptools from 68.0.0 to 70.0.0 (#219) +- Update poetry lock file and poetry and python versions in pipelines (#216) +- Update publishing flow to use ni/python-actions (#227) +- Adopt ni/python-actions for PR builds (#235) +- Make format command improvements (#221) +- Update README (#222) +- Poetry-lock-update - skip PR if no changes (#213) +- Pin to 0.18 because 0.19 is broken (#225) +- GitHub: Upgrade from ubuntu-20.04 to ubuntu-latest (#238) +- Configure Renovate (#239) +- Remove scheduled cron job from workflow +- Add self to code owners (#243) +- Update poetry lock files (multiple PRs: #177, #186, #188, #189, #190, #191, #193, #194, #195, #197, #198, #199, #200, #201, #202, #206, #207, #208, #209, #210, #211) + +### Fixed +- Fix formatting files with unicode (#242) +- Fix acknowledge when run on multiple files (#244) + +### Security +- Bump rexml from 3.2.8 to 3.3.3 in /docs (#192) +- Bump rexml from 3.3.3 to 3.3.6 in /docs (#196) +- Bump rexml from 3.3.6 to 3.3.9 in /docs (#203) +- Bump rexml from 3.3.9 to 3.4.2 in /docs (#237) +- Bump nokogiri from 1.16.5 to 1.18.3 in /docs (#212) +- Bump nokogiri from 1.18.3 to 1.18.4 in /docs (#214) +- Bump nokogiri from 1.18.4 to 1.18.8 in /docs (#217) +- Bump nokogiri from 1.18.8 to 1.18.9 in /docs (#231) +- Update ruby packages (multiple PRs: #245, #246) + ## [0.4.9] - 2025-02-03 ### Fixed From a0f5163f21541930231c7ba3e3e5e1b50c81bd74 Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Fri, 6 Mar 2026 13:45:39 -0600 Subject: [PATCH 3/7] add changelog to wheel links --- pyproject.toml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 0624423..00d5036 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,6 +11,10 @@ repository = "https://github.com/ni/python-styleguide" license = "MIT" include = ["ni_python_styleguide/config.toml"] +[tool.poetry.urls] +"Changelog" = "https://github.com/ni/python-styleguide/blob/main/CHANGELOG.md" + + [tool.poetry.dependencies] python = "^3.9" From 7e1ffb418dc3463864f9ccc46cc02e34d58043dd Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Fri, 6 Mar 2026 13:57:17 -0600 Subject: [PATCH 4/7] hand cleanup unreleased portion of changelog --- CHANGELOG.md | 28 +++------------------------- 1 file changed, 3 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 046f892..c0d99c3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,41 +11,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Add vim/neovim integration instructions to README (#205) +- Add VSCode integration instructions to README (#222) - Adopt flake8-tidy-imports to enforce O.1.5 (#223) - Add fallbacks to `_get_application_import_names` (#234) +- Make format command (#221) ### Changed - Drop Python 3.7 support (#218) -- Bump black from 23.3.0 to 24.3.0 (#220) -- Bump setuptools from 68.0.0 to 70.0.0 (#219) -- Update poetry lock file and poetry and python versions in pipelines (#216) -- Update publishing flow to use ni/python-actions (#227) -- Adopt ni/python-actions for PR builds (#235) -- Make format command improvements (#221) -- Update README (#222) -- Poetry-lock-update - skip PR if no changes (#213) -- Pin to 0.18 because 0.19 is broken (#225) -- GitHub: Upgrade from ubuntu-20.04 to ubuntu-latest (#238) -- Configure Renovate (#239) -- Remove scheduled cron job from workflow -- Add self to code owners (#243) -- Update poetry lock files (multiple PRs: #177, #186, #188, #189, #190, #191, #193, #194, #195, #197, #198, #199, #200, #201, #202, #206, #207, #208, #209, #210, #211) ### Fixed - Fix formatting files with unicode (#242) - Fix acknowledge when run on multiple files (#244) -### Security -- Bump rexml from 3.2.8 to 3.3.3 in /docs (#192) -- Bump rexml from 3.3.3 to 3.3.6 in /docs (#196) -- Bump rexml from 3.3.6 to 3.3.9 in /docs (#203) -- Bump rexml from 3.3.9 to 3.4.2 in /docs (#237) -- Bump nokogiri from 1.16.5 to 1.18.3 in /docs (#212) -- Bump nokogiri from 1.18.3 to 1.18.4 in /docs (#214) -- Bump nokogiri from 1.18.4 to 1.18.8 in /docs (#217) -- Bump nokogiri from 1.18.8 to 1.18.9 in /docs (#231) -- Update ruby packages (multiple PRs: #245, #246) - ## [0.4.9] - 2025-02-03 ### Fixed @@ -294,6 +271,7 @@ Release pipeline was broken, retrigger push to pypi.org ### Added - Initial Release 🚀 +[Unreleased]: https://github.com/ni/python-styleguide/compare/v0.4.9...main [0.4.9]: https://github.com/ni/python-styleguide/compare/v0.4.8...v0.4.9 [0.4.8]: https://github.com/ni/python-styleguide/compare/v0.4.7...v0.4.8 [0.4.7]: https://github.com/ni/python-styleguide/compare/v0.4.6...v0.4.7 From b93ca07e8b2fd31dc89cff54d74a9d6f35e705fa Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Fri, 6 Mar 2026 14:04:33 -0600 Subject: [PATCH 5/7] fix this year release dates --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c0d99c3..5eb0066 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,12 +23,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fix formatting files with unicode (#242) - Fix acknowledge when run on multiple files (#244) -## [0.4.9] - 2025-02-03 +## [0.4.9] - 2026-02-03 ### Fixed - Work around "No module named 'pkg_resources'" by pinning setuptools to <82 (#275) -## [0.4.8] - 2025-01-23 +## [0.4.8] - 2026-01-23 ### Fixed - Pin black to version that supports Python < 3.10 still (#262) From da1fac907f599f08b0d1bf3b482f617b4c65738f Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Fri, 6 Mar 2026 15:48:15 -0600 Subject: [PATCH 6/7] Apply suggestion from @bkeryan Co-authored-by: Brad Keryan --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5eb0066..fc3925c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -142,7 +142,8 @@ No changes documented for this release. ## [0.1.17] - 2023-10-12 -Testing release pipeline +### Changed +- Testing release pipeline ## [0.1.15] - 2023-10-10 From 0ca77d01ca0560f204a5872241bb194903ee19d7 Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Fri, 6 Mar 2026 15:53:42 -0600 Subject: [PATCH 7/7] move plug in adds to the correct release --- CHANGELOG.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fc3925c..1dea3fa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -239,14 +239,16 @@ Release pipeline was broken, retrigger push to pypi.org ### Fixed - Fix auto-suppression handling blank files (#66) -## [0.1.5.0] - 2021-02-12 - ### Added -- Add flake8-import-order to rules being evaluated (#49) - Add hacking to rejected plugins (#50) - Reject flake8-commas (#51) - Reject flake8-isort (#52) +## [0.1.5.0] - 2021-02-12 + +### Added +- Add flake8-import-order to rules being evaluated (#49) + ## [0.1.4] - 2021-02-02 ### Added