Release 5.0.0 (#21)

radeklat · Dec 30, 2022 · 3d315b4 · 3d315b4
1 parent 5396e69
commit 3d315b4
Show file tree

Hide file tree

Showing 15 changed files with 723 additions and 959 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -31,14 +31,12 @@ jobs: # A basic unit of work in a run
       python_version:
         type: string
     docker:
-      - image: circleci/python:<< parameters.python_version >>
+      - image: cimg/python:<< parameters.python_version >>
         environment:
           PIPENV_VENV_IN_PROJECT: "true"
     working_directory: << pipeline.parameters.working_directory >>
     steps:
       - checkout
-      - run: sudo chown -R circleci:circleci /usr/local/bin
-      - run: sudo chown -R circleci:circleci /usr/local/lib/python<< parameters.python_version >>/site-packages
       - restore_cache:
           key: << pipeline.parameters.cache_version >>-<< pipeline.parameters.project_name >>-<< parameters.python_version >>-{{ checksum "poetry.lock" }}
       - run:
@@ -57,8 +55,6 @@ jobs: # A basic unit of work in a run
           key: << pipeline.parameters.cache_version >>-<< pipeline.parameters.project_name >>-<< parameters.python_version >>-{{ checksum "poetry.lock" }}
           paths:
             - ".venv"
-            - "/usr/local/bin"
-            - "/usr/local/lib/python<< parameters.python_version >>/site-packages"
       - run:
           name: Unit tests
           command: << pipeline.parameters.command_prefix >> test-unit
@@ -82,13 +78,11 @@ jobs: # A basic unit of work in a run
   build:
     working_directory: << pipeline.parameters.working_directory >>
     docker: # run the steps with Docker
-      - image: circleci/python:<< pipeline.parameters.python_version >>
+      - image: cimg/python:<< pipeline.parameters.python_version >>
         environment:
           PIPENV_VENV_IN_PROJECT: "true"
     steps:
       - checkout
-      - run: sudo chown -R circleci:circleci /usr/local/bin
-      - run: sudo chown -R circleci:circleci /usr/local/lib/python<< pipeline.parameters.python_version >>/site-packages
       - restore_cache:
           key: << pipeline.parameters.cache_version >>-<< pipeline.parameters.project_name >>-<< pipeline.parameters.python_version >>-{{ checksum "poetry.lock" }}
       - run:
@@ -103,7 +97,7 @@ jobs: # A basic unit of work in a run
   publish:
     working_directory: << pipeline.parameters.working_directory >>
     docker: # run the steps with Docker
-      - image: circleci/python:<< pipeline.parameters.python_version >>
+      - image: cimg/python:<< pipeline.parameters.python_version >>
     steps:
       - attach_workspace:
           at: << pipeline.parameters.working_directory >>
@@ -125,11 +119,9 @@ jobs: # A basic unit of work in a run
   release:
     working_directory: << pipeline.parameters.working_directory >>
     docker:
-      - image: circleci/python:<< pipeline.parameters.python_version >>
+      - image: cimg/python:<< pipeline.parameters.python_version >>
     steps:
       - checkout
-      - run: sudo chown -R circleci:circleci /usr/local/bin
-      - run: sudo chown -R circleci:circleci /usr/local/lib/python<< pipeline.parameters.python_version >>/site-packages
       - restore_cache:
           key: << pipeline.parameters.cache_version >>-<< pipeline.parameters.project_name >>-<< pipeline.parameters.python_version >>-{{ checksum "poetry.lock" }}
       - gh/setup
@@ -154,7 +146,7 @@ workflows:
           context: << pipeline.parameters.project_name >>
           matrix:
             parameters:
-              python_version: [ "3.7", "3.8", "3.9", "3.10" ]
+              python_version: [ "3.7", "3.8", "3.9", "3.10", "3.11" ]
       - build:
           name: Build
           requires:

diff --git a/.pylintrc b/.pylintrc
@@ -56,12 +56,10 @@ confidence=
 # --disable=W"
 disable=missing-docstring,
         missing-type-doc,
-        missing-returns-doc,
         missing-return-type-doc,
         missing-yield-doc,
         missing-yield-type-doc,
         logging-fstring-interpolation,
-        raising-string,
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,103 +5,126 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 Types of changes are:
 
-* **Added** for new features.
-* **Changed** for changes in existing functionality.
-* **Deprecated** for soon-to-be removed features.
-* **Removed** for now removed features.
-* **Fixed** for any bug fixes.
-* **Security** in case of vulnerabilities.
+- **Breaking changes** for breaking changes.
+- **Features** for new features or changes in existing functionality.
+- **Fixes** for any bug fixes.
+- **Deprecated** for soon-to-be removed features.
 
 ## [Unreleased]
 
+## [5.0.0] - 2022-12-30
+
+### Breaking changes
+
+- Removed `version_check.check_python_support()`. Python version support should be done by package manager instead.
+- Removed unused constants from `constants`: `__version__`, `APPLICATION_NAME`, `MIN_SUPPORTED_PYTHON_VERSION_INCLUSIVE` and `MAX_SUPPORTED_PYTHON_VERSION_EXCLUSIVE`
+
+### Features
+
+- Added support for Python 3.11
+- Added default timeout of 30s to all `requests` calls to prevent undesirably long waiting for responses.
+
+### Fixes
+
+- Dependencies update
+
 ## [4.0.2] - 2022-07-06
 
-### Fixed
+### Fixes
 
 - Dependencies update
 
 ## [4.0.1] - 2022-02-08
 
-### Fixed
+### Fixes
 
 - Wrong Python requirement clause in pyproject.toml causing the library not being available for Python 3.10.
 - Dependencies update.
 
 ## [4.0.0] - 2021-12-01
 
-### Added
+### Features
 
 - Support for Python 3.9 and 3.10
 
-### Changed
-
-- **Breaking:** `github.GitHubIssueState` states `open` and `closed` to `OPEN` and `CLOSED`.
-- **Breaking:** Top level import renamed from `issuewatcher` to `issue_watcher` to match the package name.
+### Breaking changes
 
-### Removed
+- `github.GitHubIssueState` states `open` and `closed` to `OPEN` and `CLOSED`.
+- Top level import renamed from `issuewatcher` to `issue_watcher` to match the package name.
+- Removed support for Python 3.6
 
-- **Breaking:** Support for Python 3.6
-
-### Fixed
+### Fixes
 
 - Update dependencies.
 - Missing explicit encoding in `open`.
 
 ## [3.0.0] - 2021-01-04
 
-### Changed
+### Breaking changes
+
 - `AssertGitHubIssue.fixed_in()` will fail with `AssertionError` when list of versions from GitHub doesn't return any valid semantic versions.
 
-### Fixed
+### Fixes
+
 - DeprecationError about soon to be removed `LegacyVersion` from `packaging`
 
 ## [2.3.0] - 2020-06-04
 
-### Added
+### Features
+
 - Option to check release numbers with `AssertGitHubIssue.fixed_in()`.
 
 ## [2.2.4] - 2020-05-06
 
-### Fixed
+### Fixes
+
 - Deprecation in the `semver` library.
 
 ## [2.2.3] - 2020-03-25
 
-### Fixed
+### Fixes
+
 - Fixed version of pylint until testing script is compatible with 2.5.0+
 
 ## [2.2.2] - 2020-03-25
 
-### Fixed
+### Fixes
+
 - Annotated package as typed according to [PEP 561](https://www.python.org/dev/peps/pep-0561/).
 
 ## [2.2.1] - 2019-11-08
 
-### Changed
-- Verified support for Python 3.8 which required couple of constants to be changed.
+### Features
+
+- Verified support for Python 3.8 which required a couple of constants to be changed.
 
 ## [2.2.0] - 2019-10-20 
 
-### Added
+### Features
+
 - Python version check to warn/fail for unsupported Python versions.
 
 ## [2.1.1] - 2019-10-19
 
-### Fixed
+### Fixes
+
 - New mypy issue with bytes strings in format function.
 
 ## [2.1.0] - 2019-10-06
 
-### Added
+### Features
+
 - `AssertGitHubIssue.current_release()` shows current number of releases in failing test when no number given.
 
 ## [2.0.0] - 2019-10-06
 
-### Added
+### Features
+
 - Compatibility with pytest
 - Repository ID supplied through constructor as a single string
 
-### Changed
+### Breaking changes
+
 - Tests rewritten from unittest to pytest
 - GitHub issue class and assertions drop duplicate or unnecessary information for their name:
     - `GitHubIssueTestCase` -> `AssertGitHubIssue`
@@ -110,35 +133,38 @@ Types of changes are:
     - `assert_github_issue_is_closed` -> `is_closed`
     - `assert_no_new_release_is_available` -> `current_release`
 - Method parameter `issue_number` renamed to `issue_id` in `is_state()`, `is_open()` and `is_closed()`.
-
-### Removed
-- Sub-classing of `unittest.TestCase`
-- Setting repository ID through class attributes
+- Removed sub-classing of `unittest.TestCase`
+- Removes setting repository ID through class attributes
 
 ## [1.2.0] - 2019-08-14
 
-### Added
+### Features
+
 - Caching functionality to speed up tests involving network calls and prevent API quota depletion.
 - `CACHE_INVALIDATION_IN_SECONDS` [environment variables](README.md#environment-variables) for changing default cache invalidation period or disabling cache completely.
 
 ## [1.1.1] - 2019-08-08
 
-### Fixed
+### Fixes
+
 - Drops Python 3.5 from classifiers as it was never supported.
 
 ## [1.1.0] - 2019-08-05
 
-### Added
+### Features
+
 - `GITHUB_USER_NAME` and `GITHUB_PERSONAL_ACCESS_TOKEN` [environment variables](README.md#environment-variables) to allow authentication with GitHub API and higher API rate limit (5000/API token/hour instead of the default 60/host/hour).
 
 ## [1.0.0] - 2019-08-04
 
-### Added
+### Features
+
 - Initial source code
 - Error handling printing out full message received.
 - Error handling of exceeded API rate limit, showing current quota and time until quota reset.
 
-[Unreleased]: https://github.com/radeklat/issue-watcher/compare/4.0.2...HEAD
+[Unreleased]: https://github.com/radeklat/issue-watcher/compare/5.0.0...HEAD
+[5.0.0]: https://github.com/radeklat/issue-watcher/compare/releases/4.0.2...5.0.0
 [4.0.2]: https://github.com/radeklat/issue-watcher/compare/releases/4.0.1...4.0.2
 [4.0.1]: https://github.com/radeklat/issue-watcher/compare/releases/4.0.0...4.0.1
 [4.0.0]: https://github.com/radeklat/issue-watcher/compare/releases/3.0.0...4.0.0