All Versions
33
Latest Version
Avg Release Cycle
182 days
Latest Release
77 days ago

Changelog History
Page 1

  • v2.1.1 Changes

    June 01, 2022

    ๐Ÿ“š Documentation updates

    • ๐Ÿ›  Fix local extensions documentation (#1686) @alkatar21

    ๐Ÿ›  Bugfixes

    • Sanitize Mercurial branch information before checkout. (#1689) @ericof

    ๐Ÿš€ This release is made by wonderfull contributors:

    @alkatar21, @ericof and @jensens

  • v2.1.0 Changes

    May 30, 2022

    ๐Ÿ”„ Changes

    • ๐Ÿšš Move contributors and backers to credits section (#1599) @doobrie
    • test_generate_file_verbose_template_syntax_error fixed (#1671) @MaciejPatro
    • โœ‚ Removed changes related to setuptools_scm (#1629) @ozer550
    • ๐Ÿ”‹ Feature/local extensions (#1240) @mwesterhof

    CI/CD and QA changes

    • ๐Ÿ›  Check manifest: pre-commit, fixes, cleaning (#1683) @jensens
    • ๐Ÿš€ Follow PyPA guide to release package using GitHub Actions. (#1682) @ericof

    ๐Ÿ“š Documentation updates

    • ๐Ÿ›  Fix typo in dict_variables.rst (#1680) @ericof
    • ๐Ÿ“š Documentation overhaul (#1677) @jensens
    • ๐Ÿ›  Fixed incorrect link on docs. (#1649) @luzfcb

    ๐Ÿ›  Bugfixes

    • โช Restore accidentally deleted support for click 8.x (#1643) @jaklan

    ๐Ÿš€ This release was made possible by our wonderful contributors:

    @doobrie, @jensens, @ericof, @luzfcb

  • v2.0.2 Changes

    December 27, 2021

    ๐Ÿš€ Remark: This release never made it to official PyPI

    • ๐Ÿ›  Fix Python version number in cookiecutter --version and test on Python 3.10 (#1621) @ozer550
    • โœ‚ Removed changes related to setuptools_scm (#1629) @audreyfeldroy @ozer550
  • v2.0.1 Changes

    December 11, 2021

    ๐Ÿš€ Remark: This release never made it to official PyPI

    ๐Ÿ’ฅ Breaking Changes

    • ๐Ÿš€ Release preparation for 2.0.1rc1 (#1608) @audreyfeldroy
    • Replace poyo with pyyaml. (#1489) @dHannasch
    • Added: Path templates will be rendered when copy_without_render used (#839) @noirbizarre
    • โž• Added: End of line detection and configuration. (#1407) @insspb
    • โœ‚ Remove support for python2.7 (#1386) @ssbarnea

    Minor Changes

    • Adopt setuptools-scm packaging (#1577) @ssbarnea
    • ๐Ÿ‘ฏ Log the error message when git clone fails, not just the return code (#1505) @logworthy
    • ๐Ÿ‘ allow jinja 3.0.0 (#1548) @wouterdb
    • โž• Added uuid extension to be able to generate uuids (#1493) @jonaswre
    • Alert user if choice is invalid (#1496) @dHannasch
    • Replace poyo with pyyaml. (#1489) @dHannasch
    • โšก๏ธ update AUTHOR lead (#1532) @HosamAlmoghraby
    • โž• Add Python 3.9 (#1478) @gliptak
    • โž• Added: --list-installed cli option, listing already downloaded cookiecutter packages (#1096) @chrisbrake
    • โž• Added: Jinja2 Environment extension on files generation stage (#1419) @insspb
    • โž• Added: --replay-file cli option, for replay file distributing (#906) @Cadair
    • Added: _output_dir to cookiecutter context (#1034) @Casyfill
    • โž• Added: CLI option to ignore hooks (#992) @rgreinho
    • ๐Ÿ”„ Changed: Generated projects can use multiple type hooks at same time. (sh + py) (#974) @milonimrod
    • Added: Path templates will be rendered when copy_without_render used (#839) @noirbizarre
    • โž• Added: End of line detection and configuration. (#1407) @insspb
    • ๐Ÿšš Making code python 3 only: Remove python2 u' sign, fix some strings (#1402) @insspb
    • ๐Ÿšš py3: remove futures, six and encoding (#1401) @insspb
    • Render variables starting with an underscore. (#1339) @smoothml
    • ๐Ÿ”จ Tests refactoring: test_utils write issues fixed #1405 (#1406) @insspb

    CI/CD and QA changes

    • enable branch coverage (#1542) @simobasso
    • ๐Ÿš€ Make release-drafter diff only between master releases (#1568) @SharpEdgeMarshall
    • โœ… ensure filesystem isolation during tests execution (#1564) @simobasso
    • โž• add safety ci step (#1560) @simobasso
    • pre-commit: add bandit hook (#1559) @simobasso
    • Replace tmpdir in favour of tmp_path (#1545) @SharpEdgeMarshall
    • ๐Ÿ›  Fix linting in CI (#1546) @SharpEdgeMarshall
    • Coverage 100% (#1526) @SharpEdgeMarshall
    • โš™ Run coverage with matrix (#1521) @SharpEdgeMarshall
    • ๐Ÿ‘• Lint rst files (#1443) @ssbarnea
    • ๐Ÿ— Python3: Changed io.open to build-in open (PEP3116) (#1408) @insspb
    • ๐Ÿšš Making code python 3 only: Remove python2 u' sign, fix some strings (#1402) @insspb
    • ๐Ÿšš py3: remove futures, six and encoding (#1401) @insspb
    • โœ‚ Removed: Bumpversion, setup.py arguments. (#1404) @insspb
    • ๐Ÿ”จ Tests refactoring: test_utils write issues fixed #1405 (#1406) @insspb
    • โž• Added: Automatic PyPI deploy on tag creation (#1400) @insspb
    • ๐Ÿ”„ Changed: Restored coverage reporter (#1399) @insspb

    ๐Ÿ“š Documentation updates

    • ๐Ÿ›  Fix pull requests checklist reference (#1537) @glumia
    • ๐Ÿ›  Fix author name (#1544) @HosamAlmoghraby
    • โž• Add missing contributors (#1535) @glumia
    • โšก๏ธ Update CONTRIBUTING.md (#1529) @glumia
    • โšก๏ธ Update LICENSE (#1519) @simobasso
    • ๐Ÿ“„ docs: rewrite the conditional files / directories example description. (#1437) @lyz-code
    • ๐Ÿ›  Fix incorrect years in release history (#1473) @graue70
    • โž• Add slugify in the default extensions list (#1470) @oncleben31
    • ๐Ÿ“ฆ Renamed cookiecutter.package to API (#1442) @grrlic
    • ๐Ÿ›  Fixed wording detail (#1427) @steltenpower
    • ๐Ÿ“š Changed: CLI Commands documentation engine (#1418) @insspb
    • โž• Added: Example for conditional files / directories in hooks (#1397) @xyb
    • ๐Ÿ”„ Changed: README.md PyPI URLs changed to the modern PyPI last version (#1391) @brettcannon
    • ๐Ÿ›  Fixed: Comma in README.md (#1390) @Cy-dev-tex
    • ๐Ÿ›  Fixed: Replaced no longer maintained pipsi by pipx (#1395) @ndclt

    ๐Ÿ›  Bugfixes

    • โž• Add support for click 8.x (#1569) @cjolowicz
    • ๐Ÿ‘ฎ Force click<8.0.0 (#1562) @SharpEdgeMarshall
    • โœ‚ Remove direct dependency on markupsafe (#1549) @ssbarnea
    • ๐Ÿ›  fixes prompting private rendered dicts (#1504) @juhuebner
    • ๐Ÿ“œ User's JSON parse error causes ugly Python exception #809 (#1468) @noone234
    • 0๏ธโƒฃ config: set default on missing default_context key (#1516) @simobasso
    • ๐Ÿ›  Fixed: Values encoding on Windows (#1414) @agateau
    • ๐Ÿ›  Fixed: Fail with gitolite repositories (#1144) @javiersanp
    • MANIFEST: Fix file name extensions (#1387) @sebix

    ๐Ÿ—„ Deprecations

    • โœ‚ Removed: Bumpversion, setup.py arguments. (#1404) @insspb
    • โœ‚ Removed support for Python 3.6 and PyPy (#1608) @audreyfeldroy

    ๐Ÿš€ This release was made possible by our wonderful contributors:

    @Cadair, @Casyfill, @Cy-dev-tex, @HosamAlmoghraby, @SharpEdgeMarshall, @agateau, @audreyfeldroy, @brettcannon, @chrisbrake, @cjolowicz, @dHannasch, @gliptak, @glumia, @graue70, @grrlic, @insspb, @javiersanp, @jonaswre, @jsoref, @Jthevos, @juhuebner, @logworthy, @lyz-code, @milonimrod, @ndclt, @noirbizarre, @noone234, @oncleben31, @ozer550, @rgreinho, @sebix, @Sahil-101, @simobasso, @smoothml, @ssbarnea, @steltenpower, @wouterdb, @xyb, Christopher Wolfe and Hosam Almoghraby ( RIAG Digital )

  • v1.7.2 Changes

    April 21, 2019

    ๐Ÿ”„ Changes

    ๐Ÿ›  Bugfixes

    • ๐Ÿ›  Fixed: Jinja2&Six version limits causing build errors with ansible project (#1385) @insspb
  • v1.7.1 Changes

    April 21, 2019

    1.7.1 (2019-04-21)

    ๐Ÿš€ This release was focused on internal code and CI/CD changes. During this release all code was verified to match pep8, pep257 and other code-styling guides.
    ๐Ÿ Project CI/CD was significantly changed, Windows platform checks based on Appveyor engine was replaced by GitHub actions tests. Appveyor was removed. Also our CI/CD was extended with Mac builds, to verify project builds on Apple devices.

    Important Changes:

    • ๐Ÿ‘‰ Added: Added debug messages for get_user_config @ssbarnea (#1357)
    • Multiple templates per one repository feature added. @RomHartmann (#1224, #1063)
    • โšก๏ธ Update replay.py json.dump indent for easy viewing @nicain (#1293)
    • 'future' library replaced with 'six' as a more lightweight python porting library @asottile (#941)
    • โž• Added extension: Slugify template filter @ppanero (#1336)
    • Added command line option: --skip-if-file-exists, allow to skip the existing files when doing overwrite_if_exists. @chhsiao1981 (#1076)
    • ๐Ÿ“ฆ Some packages versions limited to be compatible with python2.7 and python 3.5 @insspb (#1349)

    โœ… Internal CI/CD and tests changes:

    • ๐Ÿ”€ Coverage comment in future merge requests disabled @ssbarnea (#1279)
    • ๐Ÿ›  Fixed Python 3.8 travis tests and setup.py message @insspb (#1295, #1297)
    • ๐Ÿ Travis builds extended with Windows setup for all supported python versions @insspb (#1300, #1301)
    • โšก๏ธ Update .travis.yml to be compatible with latest travis cfg specs @luzfcb (#1346)
    • โž• Added new test to improve tests coverage @amey589 (#1023)
    • โž• Added missed coverage lines highlight to pytest-coverage report @insspb (#1352)
    • ๐Ÿ“ฆ pytest-catchlog package removed from test_requirements, as now it is included in pytest @insspb (#1347)
    • ๐Ÿ›  Fixed cov-report tox invocation environment @insspb (#1350)
    • โž• Added: Release drafter support and configuration to exclude changelog update work and focus on development @ssbarnea @insspb (#1356, #1362)
    • โž• Added: CI/CD steps for Github actions to speedup CI/CD @insspb (#1360)
    • โœ‚ Removed: Appveyor CI/CD completely removed @insspb @ssbarnea @insspb (#1363, #1367)

    ๐Ÿ’… Code style and docs changes:

  • v1.7.0 Changes

    December 22, 2019

    Important changes

    • โฌ‡๏ธ Drop support for EOL Python 3.3, 3.4, thanks to @hugovk, @jamescurtin and @insspb (#1024)
    • Prevent click API v7.0 from showing choices when already shown, thanks to @rly and @luzfcb (#1168)
    • ๐Ÿ‘‰ Make sure to preserve the order of items in the generated cookiecutter context, thanks to @hackebrot (#1074)
    • ๐Ÿ›  Fixed DeprecationWarning for a regular expression on python 3.6, thanks to @reinout (#1124)
    • ๐Ÿ‘‰ Use io.open contextmanager when reading hook files, thanks to @jcb91 (#1147)

    PEP related changes

    • ๐Ÿ“„ PEP257 fixing docstrings in exceptions.py. Thanks to @MinchinWeb (#1237)
    • ๐Ÿ“„ PEP257 fixing docstrings in replay.py. Thanks to @kishan (#1234)
    • โœ… PEP257 fixing docstrings in test_unzip.py. Thanks to @tonytheleg and @insspb (#1236, #1262)
    • Update docstrings in cookiecutter/main.py, cookiecutter/ __init__.py, and cookiecutter/log.py to follow the PEP 257 style guide, thanks to @meahow (#998, #999, #1000)
    • ๐Ÿ’… Update docstrings in cookiecutter/utils.py to follow the PEP 257 style guide, thanks to @dornheimer(#1026)
    • โšก๏ธ Update prompt.py to match pep257 guidelines, thanks to @jairideout (#1105)

    ๐Ÿ“š Documentation changes

    • โšก๏ธ Updates REAMDE.md with svg badge for appveyor. Thanks to @sobolevn (#1254)
    • โž• Add missing {% endif %} to Choice Variables example. Thanks to @mattstibbs (#1249)
    • ๐Ÿ“š Core documentation converted to Markdown format thanks to @wagnernegrao, @insspb (#1216)
    • Add a CODE_OF_CONDUCT.md file to the project, thanks to @andreagrandi (#1009)
    • Fix grammar in Choice Variables documentation, thanks to @jubrilissa (#1011)
    • โšก๏ธ Update installation docs with links to the Windows Subsystem and GNU utilities, thanks to @Nythiennzo for the PR and @BruceEckel for the review (#1016)
    • โšก๏ธ Update tutorial with explanation for how cookiecutter finds the template file, thanks to @accraze(#1025)
    • ๐Ÿ‘Œ Improve user documentation for writing hooks, thanks to @jonathansick (#1057)
    • Document use of cookiecutter-template topic on GitHub, thanks to @ssbarnea (#1189)
    • โšก๏ธ Update README badge links, thanks to @luzfcb (#1207)
    • ๐Ÿ“š Update link to Jinja2 extensions documentation, thanks to @dacog (#1193)

    โœ… Tests changes

    • ๐Ÿ›  Fixed tests sequence for appveyor, to exclude file not found bug. Thanks to @insspb (#1257)
    • โšก๏ธ Tests update: use sys.executable when invoking python in python 3 only environment thanks to @vincentbernat (#1221)
    • โœ… Test the codebase with python3.8 beta on tox and travis-ci (#1206), thanks to @mihrab34
    • Require pip 9.0.0 or newer for tox environments, thanks to @hackebrot (#1215)
    • โฌ†๏ธ Upgrade flake8 to version 3.5.0, thanks to @cclauss (#1038)
    • โšก๏ธ Update CI config files to use TOXENV environment variable, thanks to @asottile (#1019)

    Templates list modification

  • v1.6.0 Changes

    October 15, 2017

    ๐Ÿš€ The primary goal of this release was to add support for templates from Zip files or Zip URLs.

    ๐Ÿ†• New Features

    • Include template path or template URL in cookiecutter context under _template, thanks to @aroig (#774)
    • โž• Add a URL abbreviation for GitLab template projects, thanks to @hackebrot (#963)
    • โž• Add option to use templates from Zip files or Zip URLs, thanks to @freakboy3742 (#961)

    ๐Ÿ› Bug Fixes

    • ๐Ÿ›  Fix an issue with missing default template abbreviations for when a user defined custom abbreviations, thanks to @noirbizarre for the issue report and @hackebrot for the fix (#966, #967)
    • Preserve existing output directory on project generation failure, thanks to @ionelmc for the report and @michaeljoseph for the fix (#629, #964)
    • ๐Ÿ›  Fix Python 3.x error handling for git operation failures, thanks to @jmcarp (#905)

    Other Changes

  • v1.5.1 Changes

    February 04, 2017

    ๐Ÿš‘ Hotfix release to address an issue with dict variables.

    ๐Ÿ†• New Features

    • ๐Ÿ“š Major update to installation documentation, thanks to @stevepiercy (#880)

    ๐Ÿ› Bug Fixes

    • 0๏ธโƒฃ Resolve an issue around default values for dict variables, thanks to @e-kolpakov for raising the issue and @hackebrot for the PR (#882, #884)

    Other Changes

  • v1.5.0 Changes

    December 18, 2016

    ๐Ÿš€ The primary goal of this release was to add command-line support for passing extra context, address minor bugs and make a number of improvements.

    ๐Ÿ†• New Features

    • Inject extra context with command-line arguments, thanks to @msabramo and @michaeljoseph (#666).
    • โšก๏ธ Updated conda installation instructions to work with the new conda-forge distribution of Cookiecutter, thanks to @pydanny and especially @bollwyvl (#232, #705).
    • ๐Ÿ”จ Refactor code responsible for interaction with version control systems and raise better error messages, thanks to @michaeljoseph (#778).
    • โž• Add support for executing cookiecutter using python -m cookiecutter or from a checkout/zip file, thanks to @brettcannon (#788).
    • ๐Ÿ†• New CLI option --debug-file PATH to store a log file on disk. By default no log file is written. Entries for DEBUG level and higher. Thanks to @hackebrot (#792).
    • 0๏ธโƒฃ Existing templates in a user's cookiecutters_dir (default is ~/.cookiecutters/) can now be referenced by directory name, thanks to @michaeljoseph (#825).
    • โž• Add support for dict values in cookiecutter.json, thanks to @freakboy3742 and @hackebrot (#815, #858).
    • โž• Add a jsonify filter to default jinja2 extensions that json.dumps a Python object into a string, thanks to @aroig (#791).

    ๐Ÿ› Bug Fixes

    • ๐Ÿ›  Fix typo in the error logging text for when a hook did not exit successfully, thanks to @luzfcb (#656)
    • Fix an issue around replay file names when cookiecutter is used with a relative path to a template, thanks to @eliasdorneles for raising the issue and @hackebrot for the PR (#752, #753)
    • ๐Ÿ›  Ignore hook files with tilde-suffixes, thanks to @hackebrot (#768)
    • ๐Ÿ›  Fix a minor issue with the code that generates a name for a template, thanks to @hackebrot (#798)
    • ๐Ÿ– Handle empty hook file or other OS errors, thanks to @christianmlong for raising this bug and @jcarbaugh and @hackebrot for the fix (#632, #729, #862)
    • Resolve an issue with custom extensions not being loaded for pre_gen_project and post_gen_project hooks, thanks to @cheungnj (#860)

    Other Changes