A community-maintained Python framework for creating mathematical animations.
Prepare v0.6.0 (#1434)
Benjamin Hackle5a63077cbcd
diff --git a/docs/source/changelog/0.6.0-changelog.rst b/docs/source/changelog/0.6.0-changelog.rstnew file mode 100644index 000000000..02254b8d3--- /dev/null+++ b/docs/source/changelog/0.6.0-changelog.rst@@ -0,0 +1,476 @@+******+v0.6.0+******++:Date: May 02, 2021++Contributors+============++A total of 40 people contributed to this+release. People with a '+' by their names authored a patch for the first+time.++* Abel Aebker+* Abhijith Muthyala+* Adam Ryczkowski ++* Alex Lembcke ++* Anton Ballmaier+* Aron+* Benjamin Hackl+* Darylgolden+* Deniz Hasler ++* Devin Neal+* Elisha Hollander ++* Erik Tastepe ++* Jan-Hendrik Müller+* Jason Villanueva+* Laith Bahodi+* Mark Miller+* Mohammad Al-Fetyani+* Naveen M K+* Newell Jensen ++* Nidhal Baccouri ++* Nikhil Garuda ++* Peilonrayz ++* Raghav Goel+* Ricky Chon ++* friedkeenan+* kamilczerwinski22 ++* sparshg+++The patches included in this release have been reviewed by+the following contributors.++* Aathish Sivasubrahmanian+* Abel Aebker+* Abhijith Muthyala+* Adam Ryczkowski+* Alex Lembcke+* Anton Ballmaier+* Aron+* Benjamin Hackl+* Darylgolden+* Deniz Hasler+* Devin Neal+* Elisha Hollander+* GameDungeon+* Hugues Devimeux+* Jan-Hendrik Müller+* Jason Villanueva+* KingWampy+* Laith Bahodi+* Mark Miller+* Mohammad Al-Fetyani+* Naveen M K+* Nidhal Baccouri+* Nikhil Garuda+* Oliver+* Philipp Imhof+* Raghav Goel+* Ricky Chon+* friedkeenan+* sparshg++Pull requests merged+====================++A total of 112 pull requests were merged for this release.++Breaking changes+----------------++* `#1347 <https://github.com/ManimCommunity/manim/pull/1347>`__: Restructure vector_field module and add documentation+ :class`~.VectorField` is renamed to :class:`~.ArrowVectorField` and a new class :class:`~.VectorField` is added as a superclass for :class:`~.ArrowVectorField` and :class:`~.StreamLines`. :class:`~.AnimatedStreamLines` is removed. It's functionality is moved to :class:`~.StreamLines`. Added a lot of new options when working with vector fields. :class:`~.ShowPassingFlashWithThinningStrokeWidth` was moved to the indication module.++* `#1161 <https://github.com/ManimCommunity/manim/pull/1161>`__: Upgrades to CoordinateSystem and graphing.+ Breaking changes were introduced to :class:`~.Axes`, :class:`~.ThreeDAxes`, :class:`~.NumberPlane` and :class:`~.NumberLine`+ All the above now use lists to construct their ranges as opposed to explicitly defining these values. `x_range` has replaced `x_min`, `x_max` and defining the step is much easier with `x_step` --> ``x_range`` : ``[x_min, x_max, x_step]``. There were also many upgrades to these classes which improve their functionality and appearance.++ ``NumberLineOld`` was introduced to continue support for :class:`~.GraphScene`, although we are moving away from GraphScene and intend to deprecate it in a future release.++* `#1013 <https://github.com/ManimCommunity/manim/pull/1013>`__: Refactored the Command Line Interface to use Click instead of Argparse+ This change breaks the CLI API to organize the structure of Manim Community's commands, options, and arguments.++ To be more in line with POSIX compliant CLI conventions, options for commands are given *BEFORE* their arguments.+ In Argparse: ``manim basic.py -p -ql``+ With Click: ``manim -p -ql basic.py``++ Although this is primarily a refactor and most of the common options are still there, some options have been added/removed. Use the ``manim`` command's ``-h``, ``--help`` option, or simply run the command without providing options/arguments to view the help page with the full list of subcommands/options/arguments.++ - Added a ``--fps``/``--frame_rate`` option which allows for custom fps that don't have to be integer (i.e. 29.97, 23.98, etc.). Users no longer have to specify the FPS from within a config file. Additionally, the ``--webgl_renderer_fps`` option has been removed. Use ``--fps`` or ``--frame_rate`` instead.+ - Added a ``--renderer`` option which you can use to select your choice of renderer (e.g. ``--renderer=opengl``). There are currently *THREE* renderers to choose from!+ - Removed the ``--background_color`` option. Reassigned the ``--background_color`` option's shorthand ``-c`` to ``--config_file``.+ - Removed the ``--leave_progress_bars`` option. Use ``--progress_bars=leave`` instead.+ - Removed the deprecated render quality flags, in particular: ``-l``, ``-m``, ``-h``, ``-k``.+ - Removed the ``--sound`` option. It lost support long ago with the removal of SoX.++Deprecated classes and functions+--------------------------------++* `#1431 <https://github.com/ManimCommunity/manim/pull/1431>`__: Fix CLI bugs+ - Fixed conflict with ``-f`` which was previously assigned to both ``--show_in_file_browser`` and ``--format`` by removing ``-f`` from ``--format``. A warning is issued that ``-f`` will soon move to ``--format``.+ - Added back in flags to render the files as gif/last frame. Deprecated them in favor of ``--format``.+ - Fixed the broken ``--output_file``/``-o`` option.+ - Fixed an issue where the ``-qh`` quality option was interpreted as ``-q`` ``-h``, prompting the help page.++* `#1354 <https://github.com/ManimCommunity/manim/pull/1354>`__: Refactored a few functions in space_ops.py, deprecated :func:`~.angle_between`+++* `#1370 <https://github.com/ManimCommunity/manim/pull/1370>`__: Remove TexMobject and TextMobject+ TexMobject and TextMobject have been deprecated for a while, they are now fully removed. Use Tex or MathTex instead.++* `#1349 <https://github.com/ManimCommunity/manim/pull/1349>`__: Removed the deprecated ``SmallDot`` mobject+++* `#1259 <https://github.com/ManimCommunity/manim/pull/1259>`__: Removed deprecated CairoText class++New features+------------++* `#1386 <https://github.com/ManimCommunity/manim/pull/1386>`__: Implement utility methods for adding/removing vertices and edges of graphs; allow custom mobjects as vertices+++* `#1385 <https://github.com/ManimCommunity/manim/pull/1385>`__: Added :meth:`~.Axes.get_line_graph` for plotting a line graph+ Added :meth:`~.Axes.get_line_graph` that returns a line graph from lists of points along x, y and z (optional) axes.++* `#1381 <https://github.com/ManimCommunity/manim/pull/1381>`__: Hot reloading for the OpenGL renderer+ Rerun scene when the input file is modified++* `#1383 <https://github.com/ManimCommunity/manim/pull/1383>`__: Overhaul of the :mod:`~.animation.indication` module interfaces+ - Added class `Circumscribe` combining functionality of `CircleIndicate`, `AnimationOnSurroundingRectangle`, `ShowPassingFlashAround`, `ShowCreationThenDestructionAround`, `ShowCreationThenFadeAround`, which have all been deprecated.+ - Changes to `Flash`: `flash_radius` parameter now defines inner radius of the animation. Added new parameter `time_width`.+ - `ShowCreationThenDestruction` has been deprecated in favor of `ShowPassingFlash`+ - Changes to `ApplyWave`: New implementation giving more flexibility with new parameters `wave_func`, `time_width` and`ripples`+ - Renamed `WiggleOutThenIn` to `Wiggle` (`WiggleOutThenIn` has been deprecated)+ - Added documentation and examples to all the above+ - Other minor enhancements and bug-fixes++* `#1348 <https://github.com/ManimCommunity/manim/pull/1348>`__: Added :class:`~.Polyhedron`, and platonic solids :class:`~.Tetrahedron`, :class:`~.Octahedron`, :class:`~.Icosahedron` and :class:`~.Dodecahedron`+++* `#1285 <https://github.com/ManimCommunity/manim/pull/1285>`__: Add :meth:`~.Scene.interactive_embed` for OpenGL rendering+ :meth:`~.Scene.interactive_embed` allows interaction with Scene via mouse and keyboard as well as dynamic commands via an iPython terminal.++* `#1261 <https://github.com/ManimCommunity/manim/pull/1261>`__: Render image automatically if no animation is played in a scene+ - If no animations in scene and asked to preview/render a video, preview/render an image instead of raising a confusing error.++* `#1200 <https://github.com/ManimCommunity/manim/pull/1200>`__: Add text and SVG mobjects to OpenGL+ Added OpenGL-compatible text and SVG mobjects++Enhancements+------------++* `#1398 <https://github.com/ManimCommunity/manim/pull/1398>`__: Fix and enhance `Mobject.arrange_in_grid`+ `arrange_in_grid` now actually arranges submobjects in a grid. Added new parameters `buff`, `cell_alignment`, `row_alignments`, `col_alignments`, `row_heights`, `col_widths`, `flow_order`.++* `#1407 <https://github.com/ManimCommunity/manim/pull/1407>`__: Fix bug and rename :meth:`vector_coordinate_label` to :meth:`~.Vector.coordinate_label` and move it to :class:`geometry.py`+++* `#1380 <https://github.com/ManimCommunity/manim/pull/1380>`__: Allow image objects as background images+++* `#1391 <https://github.com/ManimCommunity/manim/pull/1391>`__: Add `path_arc` support to `.animate` syntax+ The parameter `path_arc` of :class:`~.Transform` now works with the `.animate` syntax++* `#1364 <https://github.com/ManimCommunity/manim/pull/1364>`__: Added :meth:`~.Mobject.match_points`+ - Added :func:`~.Mobject.match_points`, which transforms the points, positions and submobjects of a Mobject to match that of the other while keeping style unchanged.++* `#1363 <https://github.com/ManimCommunity/manim/pull/1363>`__: Change of TeX complier and output file format+++* `#1359 <https://github.com/ManimCommunity/manim/pull/1359>`__: Make FILE a required argument+ * Make `FILE` a required argument, `manim/cli/render/commands.py`:L30++* `#1304 <https://github.com/ManimCommunity/manim/pull/1304>`__: Improve Tex string splitting at double braces: only split for double brace groups+++* `#1340 <https://github.com/ManimCommunity/manim/pull/1340>`__: Add OpenGL support to the new transform animations+ Made `FadeTransform`, `FadeTransformPieces`, `TransformMatchingShapes` and `TransformMatchingTex` compatible with OpenGL rendering.++* `#1343 <https://github.com/ManimCommunity/manim/pull/1343>`__: Make TexTemplate() simple, but keep Tex()'s default template+ TexTemplate() now returns a simple tex template.++* `#1321 <https://github.com/ManimCommunity/manim/pull/1321>`__: Add OpenGL support to :class:`~.AnimationGroup`+++* `#1302 <https://github.com/ManimCommunity/manim/pull/1302>`__: Raise appropriate errors in :meth:`~.VMobject.point_from_proportion`+ - Raise an error if the ``alpha`` argument is not between 0 and 1.+ - Raise an error if the :class:`~.VMobject` has no points.++* `#1315 <https://github.com/ManimCommunity/manim/pull/1315>`__: Fix performance issues with :meth:`~.VMobject.get_arc_length`, stemming from :pr:`1274`+++* `#1320 <https://github.com/ManimCommunity/manim/pull/1320>`__: Add `jpeg` extension to the default image extensions+++* `#1234 <https://github.com/ManimCommunity/manim/pull/1234>`__: Added new method :meth:`~.Mobject.get_midpoint`+ Implemented :meth:`~.Mobject.get_midpoint` to return the point that is the middle of the stroke line of an mobject.++* `#1237 <https://github.com/ManimCommunity/manim/pull/1237>`__: Notify user if they are using an outdated version of Manim+++* `#1308 <https://github.com/ManimCommunity/manim/pull/1308>`__: Improved :class:`~.ManimBanner` animations+++* `#1275 <https://github.com/ManimCommunity/manim/pull/1275>`__: Add SVG <line> element support to :class:`~.SVGMobject`+++* `#1238 <https://github.com/ManimCommunity/manim/pull/1238>`__: Add parameter ``about_point`` for :meth:`~.Mobject.rotate`+++* `#1260 <https://github.com/ManimCommunity/manim/pull/1260>`__: Change Brace from Tex to SVG (#1258)+++* `#1122 <https://github.com/ManimCommunity/manim/pull/1122>`__: Support for specifying the interpolation algorithms for individual ImageMobjects+++* `#1283 <https://github.com/ManimCommunity/manim/pull/1283>`__: Set default value of keyword ``random_seed`` in :class:`~.Scene` to ``None`` (was 0 and fixed before)+++* `#1220 <https://github.com/ManimCommunity/manim/pull/1220>`__: Added sanity checks to :meth:`~.Mobject.add_to_back` for Mobjects+ Add Mobject `add_to_back` sanity checks:+ - Raises ValueError when Mobject tries to add itself+ - Raises TypeError when a non-Mobject is added+ - Filters out incoming duplicate submobjects if at least one instance of that submobject exists in the list++* `#1249 <https://github.com/ManimCommunity/manim/pull/1249>`__: Set corners of :class:`~.Rectangle` in counterclockwise direction+ This improves the look of transformations between rectangles and other simple mobjects.++* `#1248 <https://github.com/ManimCommunity/manim/pull/1248>`__: Add Copy function to TexTemplate+++Fixed bugs+----------++* `#1368 <https://github.com/ManimCommunity/manim/pull/1368>`__: Added a check to ensure checking for the latest version was successful+++* `#1413 <https://github.com/ManimCommunity/manim/pull/1413>`__: Prevent duplication of the same mobject when adding to submobjects via :meth:`~.Mobject.add_to_back`+ Fixes #1412++* `#1395 <https://github.com/ManimCommunity/manim/pull/1395>`__: SVG transforms now handle exponent notation (6.02e23)+++* `#1355 <https://github.com/ManimCommunity/manim/pull/1355>`__: Rewrite `put_start_and_end_on` to work in 3D+++* `#1346 <https://github.com/ManimCommunity/manim/pull/1346>`__: Fixed errors introduced by stray print in :class:`~.MathTex`+++* `#1305 <https://github.com/ManimCommunity/manim/pull/1305>`__: Automatically remove long tick marks not within the range of the :class:`~NumberLine`+++* `#1296 <https://github.com/ManimCommunity/manim/pull/1296>`__: Fix random pipeline TeX failures+++* `#1274 <https://github.com/ManimCommunity/manim/pull/1274>`__: Fix :meth:`~.VMobject.point_from_proportion` to account for the length of curves.+ - Add :meth:`~.VMobject.get_nth_curve_function_with_length` and associated functions.+ - Change :meth:`~.VMobject.point_from_proportion` to use these functions to account for curve length.++Documentation-related changes+-----------------------------++* `#1430 <https://github.com/ManimCommunity/manim/pull/1430>`__: Un-deprecated GraphScene (will be deprecated later), fixed an old-style call to NumberPlane+ - More work is required in order to fully replace `GraphScene` via `Axes`, thus `GraphScene` is not deprecated yet.+ - Fixed one example in which the old `NumberPlane` syntax was used.++* `#1425 <https://github.com/ManimCommunity/manim/pull/1425>`__: Added a "How to Cite Manim" section to the Readme+++* `#1387 <https://github.com/ManimCommunity/manim/pull/1387>`__: Added Guide to Contribute Examples from GitHub Wiki to Documentation+ Added a Guide++* `#1424 <https://github.com/ManimCommunity/manim/pull/1424>`__: Fixed all current docbuild warnings+++* `#1389 <https://github.com/ManimCommunity/manim/pull/1389>`__: Adding Admonitions Tutorial to docs+++* `#1341 <https://github.com/ManimCommunity/manim/pull/1341>`__: Reduce complexity of ThreeDSurfacePlot example+++* `#1362 <https://github.com/ManimCommunity/manim/pull/1362>`__: Quick reference to modules+++* `#1376 <https://github.com/ManimCommunity/manim/pull/1376>`__: Add flake8 and isort in docs+ added 'flake8' and 'isort' usages to docs++* `#1360 <https://github.com/ManimCommunity/manim/pull/1360>`__: Grammatical error corrections in documentation+ changed a few sentences in docs/source++* `#1351 <https://github.com/ManimCommunity/manim/pull/1351>`__: Some more typehints+++* `#1358 <https://github.com/ManimCommunity/manim/pull/1358>`__: Fixed link to installation instructions for developers+++* `#1338 <https://github.com/ManimCommunity/manim/pull/1338>`__: Added documentation guidelines for type hints+++* `#1342 <https://github.com/ManimCommunity/manim/pull/1342>`__: Mutliple VauleTracker example for docs+++* `#1210 <https://github.com/ManimCommunity/manim/pull/1210>`__: Added tutorial chapter on coordinates of an mobject+++* `#1335 <https://github.com/ManimCommunity/manim/pull/1335>`__: Added import statements to examples in documentation+++* `#1245 <https://github.com/ManimCommunity/manim/pull/1245>`__: Added filled angle Example+++* `#1328 <https://github.com/ManimCommunity/manim/pull/1328>`__: Docs: Update Brace example+++* `#1326 <https://github.com/ManimCommunity/manim/pull/1326>`__: Improve documentation of :class:`~.ManimMagic` (in particular: fix documented order of CLI flags)+++* `#1323 <https://github.com/ManimCommunity/manim/pull/1323>`__: Blacken Docs Strings+++* `#1300 <https://github.com/ManimCommunity/manim/pull/1300>`__: Added typehints for :class:`~.ValueTracker`+++* `#1301 <https://github.com/ManimCommunity/manim/pull/1301>`__: Added futher docstrings and typehints to :class:`~.Mobject`+++* `#1298 <https://github.com/ManimCommunity/manim/pull/1298>`__: Add double backquotes for rst code samples (value_tracker.py)+++* `#1297 <https://github.com/ManimCommunity/manim/pull/1297>`__: Change docs to use viewcode extension instead of linkcode+ Switched ``sphinx.ext.linkcode`` to ``sphinx.ext.viewcode`` and removed ``linkcode_resolve`` in ``conf.py``.++* `#1246 <https://github.com/ManimCommunity/manim/pull/1246>`__: Added docstrings for :class:`~.ValueTracker`+++* `#1251 <https://github.com/ManimCommunity/manim/pull/1251>`__: Switch documentation from guzzle-sphinx-theme to furo+++* `#1232 <https://github.com/ManimCommunity/manim/pull/1232>`__: Further docstrings and examples for :class:`~.Mobject`+++* `#1291 <https://github.com/ManimCommunity/manim/pull/1291>`__: Grammar improvements in README.md+++* `#1269 <https://github.com/ManimCommunity/manim/pull/1269>`__: Add documentation about :meth:`~.set_color_by_tex`+++* `#1284 <https://github.com/ManimCommunity/manim/pull/1284>`__: Updated readme by providing the correct link to the example_scenes+++* `#1029 <https://github.com/ManimCommunity/manim/pull/1029>`__: Added example jupyter notebook into the examples folders+++* `#1279 <https://github.com/ManimCommunity/manim/pull/1279>`__: Added sphinx requirements to pyproject.toml+ New contributors who wanted to build the sphinx documentation had an extra step that could be removed by making use of ``poetry install``. This removes the developer's need for ``pip install -r requirements.txt``.++* `#1268 <https://github.com/ManimCommunity/manim/pull/1268>`__: Added documentation explaining the differences between manim versions+++* `#1247 <https://github.com/ManimCommunity/manim/pull/1247>`__: Added warning for the usage of `animate`+++* `#1242 <https://github.com/ManimCommunity/manim/pull/1242>`__: Added an example for the manim colormap+++* `#1239 <https://github.com/ManimCommunity/manim/pull/1239>`__: Add TinyTex installation instructions+++* `#1231 <https://github.com/ManimCommunity/manim/pull/1231>`__: Improve changelog generation script+++Changes concerning the testing system+-------------------------------------++* `#1299 <https://github.com/ManimCommunity/manim/pull/1299>`__: Red pixels (different value) now appear over green pixels (same value) in GraphicalUnitTest+++Changes to our development infrastructure+-----------------------------------------++* `#1436 <https://github.com/ManimCommunity/manim/pull/1436>`__: Cache poetry venv with `pyproject.toml` hash in key+ Cache poetry venv with `pyproject.toml` hash in key++* `#1435 <https://github.com/ManimCommunity/manim/pull/1435>`__: CI: Update poetry cache when new version is released+ Fix `test_version` failure in CI when using cached poetry venv++* `#1427 <https://github.com/ManimCommunity/manim/pull/1427>`__: Add URL's to pyproject.toml+++* `#1421 <https://github.com/ManimCommunity/manim/pull/1421>`__: Updated changelog generator's labels and removed pre-commit bot from changelog+++* `#1339 <https://github.com/ManimCommunity/manim/pull/1339>`__: CI: Fix macOS installation error from creating file in read-only file system+++* `#1257 <https://github.com/ManimCommunity/manim/pull/1257>`__: CI: Caching ffmpeg, tinytex dependencies and poetry venv+ CI: Caching ffmpeg, tinytex dependencies and poetry venv++* `#1294 <https://github.com/ManimCommunity/manim/pull/1294>`__: Added mixed-line-ending to .pre-commit-config.yaml+++* `#1278 <https://github.com/ManimCommunity/manim/pull/1278>`__: Fixed flake8 errors and removed linter/formatter workflows+++* `#1270 <https://github.com/ManimCommunity/manim/pull/1270>`__: Added isort to pre_commit file+++* `#1263 <https://github.com/ManimCommunity/manim/pull/1263>`__: CI: Turn off experimental installer for poetry to fix installation errors+ - Turn off experimental installer for poetry to prevent manim installation errors for packages.+ - Downgrade py39 to py38 for flake checks as `pip` does not enjoy py39, along with `poetry`.++* `#1255 <https://github.com/ManimCommunity/manim/pull/1255>`__: CI: Fix macOS pipeline failure+ Update `ci.yml` to update and upgrade brew if necessary before installing dependencies, and remove the unsupported `dvisvgm.86_64-darwin` package.++* `#1254 <https://github.com/ManimCommunity/manim/pull/1254>`__: Removed the comment warning that GitHub doesn't allow uploading video in the issue templates.+++* `#1216 <https://github.com/ManimCommunity/manim/pull/1216>`__: Use actions/checkout for cloning repository; black-checks+++* `#1235 <https://github.com/ManimCommunity/manim/pull/1235>`__: Fixed version of decorator at <5.0.0+++Code quality improvements and similar refactors+-----------------------------------------------++* `#1411 <https://github.com/ManimCommunity/manim/pull/1411>`__: Change `Union[float, int]` to just `float` according to PEP 484+++* `#1241 <https://github.com/ManimCommunity/manim/pull/1241>`__: Type Annotations: Fixing errors showing up in static type checking tool mypy+++* `#1319 <https://github.com/ManimCommunity/manim/pull/1319>`__: Fix mean/meant typo+ Fix typo in docs++* `#1313 <https://github.com/ManimCommunity/manim/pull/1313>`__: Singular typo fix on the Quickstart page in documentation+++* `#1292 <https://github.com/ManimCommunity/manim/pull/1292>`__: Remove unnecessary imports from files+ Imports reduced in a bunch of files++* `#1295 <https://github.com/ManimCommunity/manim/pull/1295>`__: Fix grammar and typos in the CODE OF CONDUCT+++* `#1293 <https://github.com/ManimCommunity/manim/pull/1293>`__: Minor fixes - reduce lines+ Remove unnecessary lines++* `#1281 <https://github.com/ManimCommunity/manim/pull/1281>`__: Remove all Carriage Return characters in our files+++* `#1178 <https://github.com/ManimCommunity/manim/pull/1178>`__: Format Imports using Isort+++* `#1233 <https://github.com/ManimCommunity/manim/pull/1233>`__: Fix deprecation warning for ``--use_opengl_renderer`` and ``--use_webgl_renderer``+++* `#1282 <https://github.com/ManimCommunity/manim/pull/1282>`__: Fix typing hints in vectorized_mobject.py based on mypy+++New releases+------------++* `#1434 <https://github.com/ManimCommunity/manim/pull/1434>`__: Prepare v0.6.0+diff --git a/pyproject.toml b/pyproject.tomlindex 89199f754..9e061370e 100644--- a/pyproject.toml+++ b/pyproject.toml@@ -1,6 +1,6 @@[tool.poetry]name = "manim"-version = "0.5.0"+version = "0.6.0"description = "Animation engine for explanatory math videos."authors = ["The Manim Community Developers","3b1b <[email protected]>"]license="MIT"diff --git a/scripts/dev_changelog.py b/scripts/dev_changelog.pyindex f8ba9d1c4..e962759b0 100755--- a/scripts/dev_changelog.py+++ b/scripts/dev_changelog.py@@ -70,29 +70,49 @@ PR_LABELS = {"infrastructure": "Changes to our development infrastructure","maintenance": "Code quality improvements and similar refactors","revert": "Changes that needed to be reverted again",+ "release": "New releases","unlabeled": "Unclassified changes",}-def get_authors_and_reviewers(lst, cur, github_repo, pr_nums):- pat = r"^.*\t(.*)$"+def process_pullrequests(lst, cur, github_repo, pr_nums):+ lst_commit = github_repo.get_commit(sha=this_repo.git.rev_list("-1", lst))+ lst_date = lst_commit.commit.author.date- # authors, in current release and previous to current release.- cur = set(re.findall(pat, this_repo.git.shortlog("-s", f"{lst}..{cur}"), re.M))- pre = set(re.findall(pat, this_repo.git.shortlog("-s", lst), re.M))-- cur.discard("pre-commit-ci[bot]")- # Append '+' to new authors.- authors = [s + " +" for s in cur - pre] + [s for s in cur & pre]- authors.sort()-- reviewers = []- for num in tqdm(pr_nums, desc="Fetching reviewer comments"):+ authors = set()+ reviewers = set()+ pr_by_labels = defaultdict(list)+ for num in tqdm(pr_nums, desc="Processing PRs"):pr = github_repo.get_pull(num)- reviewers.extend(rev.user.name for rev in pr.get_reviews())- reviewers = sorted(set(rev for rev in reviewers if rev is not None))+ authors.add(pr.user)+ reviewers = reviewers.union(rev.user for rev in pr.get_reviews())+ pr_labels = [label.name for label in pr.labels]+ for label in PR_LABELS.keys():+ if label in pr_labels:+ pr_by_labels[label].append(pr)+ break # ensure that PR is only added in one category+ else:+ pr_by_labels["unlabeled"].append(pr)- return {"authors": authors, "reviewers": reviewers}+ # identify first-time contributors:+ author_names = []+ for author in authors:+ name = author.name if author.name is not None else author.login+ if github_repo.get_commits(author=author, until=lst_date).totalCount == 0:+ name += " +"+ author_names.append(name)++ reviewer_names = []+ for reviewer in reviewers:+ reviewer_names.append(+ reviewer.name if reviewer.name is not None else reviewer.login+ )++ return {+ "authors": sorted(author_names),+ "reviewers": sorted(reviewer_names),+ "PRs": pr_by_labels,+ }def get_pr_nums(lst, cur):@@ -119,27 +139,6 @@ def get_pr_nums(lst, cur):return prnums-def sort_by_labels(github_repo, pr_nums):- """Sorts PR into groups based on labels.-- This implementation sorts based on importance into a singular group. If a- PR uses multiple labels, it is sorted under one label.-- """- pr_by_labels = defaultdict(list)- for num in tqdm(pr_nums, desc="Sorting by labels"):- pr = github_repo.get_pull(num)- pr_labels = [label.name for label in pr.labels]- for label in PR_LABELS.keys():- if label in pr_labels:- pr_by_labels[label].append(pr)- break # ensure that PR is only added in one category- else:- pr_by_labels["unlabeled"].append(pr)-- return pr_by_labels--def get_summary(body):pattern = '<!--changelog-start-->([^"]*)<!--changelog-end-->'has_changelog_pattern = re.search(pattern, body)@@ -159,6 +158,7 @@ def get_summary(body):"additional",nargs=-1,required=False,+ type=int,)@click.option("-o", "--outfile", type=str, help="Path and file name of the changelog output."@@ -186,11 +186,9 @@ def main(token, prior, tag, additional, outfile):pr_nums = pr_nums + list(additional)# document authors- contributors = get_authors_and_reviewers(- lst_release, cur_release, github_repo, pr_nums- )- authors = contributors["authors"]- reviewers = contributors["reviewers"]+ contributions = process_pullrequests(lst_release, cur_release, github_repo, pr_nums)+ authors = contributions["authors"]+ reviewers = contributions["reviewers"]if not outfile:outfile = (@@ -246,7 +244,7 @@ def main(token, prior, tag, additional, outfile):f"A total of {len(pr_nums)} pull requests were merged for this release.\n\n")- pr_by_labels = sort_by_labels(github_repo, pr_nums)+ pr_by_labels = contributions["PRs"]for label in PR_LABELS.keys():pr_of_label = pr_by_labels[label]