Merge pull request #564 from akaihola/release-2.1.0

Release 2.1.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -36,7 +36,7 @@ If applicable, add copy/paste the output or attach a screenshots to help explain
  - OS: [e.g. Windows / macos / Linux distribution & version]
  - Python version [e.g. 3.10.4]
  - Git version [e.g. 2.36.0]
- - Darker version [e.g. 2.0.0]
+ - Darker version [e.g. 2.1.0]
  - Black version [e.g. 22.3.0]
  - other reformatter and linter versions [e.g. `isort==5.10.1`, `mypy==0.942`
 

CHANGES.rst

@@ -3,6 +3,16 @@ Unreleased_
 
 These features will be included in the next release:
 
+Added
+-----
+
+Fixed
+-----
+
+
+2.1.0_ - 2024-03-27
+===================
+
 Added
 -----
 - Mark the Darker package as annotated with type hints.
@@ -11,6 +21,8 @@ Added
 - Update to Black 24.2.x and isort 5.13.x in pre-commit configuration.
 - Test against Flynt ``master`` branch in the CI build.
 - Update to Darkgraylib 1.1.1 to get fixes for README formatting.
+- Improved "How does it work?" section in the README.
+- README section on limitations and work-arounds.
 
 Removed
 -------
@@ -22,6 +34,7 @@ Fixed
 -----
 - Bump-version pre-commit hook pattern: ``rev: vX.Y.Z`` instead of ``X.Y.Z``.
 - Escape pipe symbols (``|``) in the README to avoid RestructuredText rendering issues.
+- Compatibility with Flynt 0.78.0 and newer.
 
 
 2.0.0_ - 2024-03-13
@@ -565,7 +578,8 @@ Added
 -----
 - Initial implementation
 
-.. _Unreleased: https://github.com/akaihola/darker/compare/2.0.0...HEAD
+.. _Unreleased: https://github.com/akaihola/darker/compare/2.1.0...HEAD
+.. _2.1.0: https://github.com/akaihola/darker/compare/2.0.0...2.1.0
 .. _2.0.0: https://github.com/akaihola/darker/compare/1.7.3...2.0.0
 .. _1.7.3: https://github.com/akaihola/darker/compare/1.7.2...1.7.3
 .. _1.7.2: https://github.com/akaihola/darker/compare/1.7.1...1.7.2

README.rst

@@ -22,9 +22,9 @@
 .. |changelog-badge| image:: https://img.shields.io/badge/-change%20log-purple
    :alt: Change log
 .. _changelog-badge: https://github.com/akaihola/darker/blob/master/CHANGES.rst
-.. |next-milestone| image:: https://img.shields.io/github/milestones/progress/akaihola/darker/21?color=red&label=release%202.1.0
+.. |next-milestone| image:: https://img.shields.io/github/milestones/progress/akaihola/darker/24?color=red&label=release%202.1.1
    :alt: Next milestone
-.. _next-milestone: https://github.com/akaihola/darker/milestone/21
+.. _next-milestone: https://github.com/akaihola/darker/milestone/24
 
 
 What?
@@ -137,11 +137,11 @@ How?
 
 To install or upgrade, use::
 
-  pip install --upgrade darker~=2.0.0
+  pip install --upgrade darker~=2.1.0
 
 Or, if you're using Conda_ for package management::
 
-  conda install -c conda-forge darker~=2.0.0 isort
+  conda install -c conda-forge darker~=2.1.0 isort
   conda update -c conda-forge darker
 
 ..
@@ -639,7 +639,7 @@ do the following:
    .. code-block:: yaml
 
       - repo: https://github.com/akaihola/darker
-        rev: v2.0.0
+        rev: v2.1.0
         hooks:
           - id: darker
 
@@ -658,7 +658,7 @@ other reformatter/linter tools you use to known compatible versions, for example
 .. code-block:: yaml
 
    - repo: https://github.com/akaihola/darker
-     rev: v2.0.0
+     rev: v2.1.0
      hooks:
        - id: darker
          args:
@@ -689,7 +689,7 @@ Note the inclusion of the isort Python package under ``additional_dependencies``
 .. code-block:: yaml
 
    - repo: https://github.com/akaihola/darker
-     rev: v2.0.0
+     rev: v2.1.0
      hooks:
        - id: darker
          args: [--isort]
@@ -734,11 +734,11 @@ Create a file named ``.github/workflows/darker.yml`` inside your repository with
            with:
              fetch-depth: 0 
          - uses: actions/setup-python@v5
-         - uses: akaihola/darker@2.0.0
+         - uses: akaihola/darker@2.1.0
            with:
              options: "--check --diff --isort --color"
              src: "./src"
-             version: "~=2.0.0"
+             version: "~=2.1.0"
              lint: "flake8,pylint==2.13.1"
 
 There needs to be a working Python environment, set up using ``actions/setup-python``

action.yml

@@ -14,9 +14,9 @@ inputs:
     required: false
     default: "."
   version:
-    description: 'Version of Darker to use, e.g. "~=2.0.0", "2.0.0", "@master"'
+    description: 'Version of Darker to use, e.g. "~=2.1.0", "2.1.0", "@master"'
     required: false
-    default: "~=2.0.0"
+    default: "~=2.1.0"
   revision:
     description: >-
       Git revision range to compare when determining modified lines.

src/darker/version.py

@@ -1,3 +1,3 @@
 """The version number for Darker is governed by this file"""
 
-__version__ = "2.0.0"
+__version__ = "2.1.0"