Introduction
============
Tools to make managing Plone core releases easier.
Installation
------------
To install plone.releaser add it to your buildout::
[release]
recipe = zc.recipe.egg
eggs = plone.releaser
To make it available in buildout.coredev, run buildout with releaser.cfg::
$ bin/buildout -c releaser.cfg
Usage
-----
Check PyPi access to all Plone packages for a certain user::
$ bin/manage checkPypi timo
Check a package for updates::
$ bin/manage checkPackageForUpdates Products.CMFPlone
Report packages with changes::
$ bin/manage report --interactive
Pulls::
$ bin/manage pulls
Changelog::
$ bin/manage changelog
Check checkout::
$ bin/manage check-checkout
Changelog
=========
.. You should *NOT* be adding new change log entries to this file.
You should create a file in the news directory instead.
For helpful instructions, please see:
https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
.. towncrier release notes start
2.2.2 (2024-04-16)
------------------
Bug fixes:
- Preserve the case of package names in versions2constraints and friends.
[maurits] (#65)
2.2.1 (2023-12-14)
------------------
Bug fixes:
- Manage changelog: read markdown files as well.
[maurits] (#48)
2.2.0 (2023-11-30)
------------------
New features:
- Add bin/manage versions2constraints command.
[maurits] (#3670)
Bug fixes:
- Fix setting version for non-lowercase package.
In the previous release this would add a duplicate line.
[maurits] (#58)
- Fix missing changelog entries when running ``bin/manage changelog``.
[maurits] (#60)
2.1.1 (2023-09-14)
------------------
Bug fixes:
- Commit all changed files when updating a package version.
We were only adding `versions.cfg` to the commit, but the change can be in `versions-extra.cfg`, or in the future also in `constraints.txt`.
[maurits] (#57)
2.1.0 (2023-09-14)
------------------
New features:
- Enable updating versions in pip constraints files.
[maurits] (#53)
- Enable updating checkouts in mxdex.ini files.
[maurits] (#53)
Bug fixes:
- Check all ``versions*.cfg`` files when updating a pin.
[maurits] (#52)
- Removed no longer working ``pulls`` command that I have never used.
Removed ``PyGithub`` and ``keyring`` dependencies that were only used for this.
Removed ``Source.path`` property that was only used for this.
[maurits] (#56)
Internal:
- Update configuration files.
[plone devs] (a7c2b777)
2.0.1 (2023-06-22)
------------------
Bug fixes:
- Allow disabling PyPI rights check, as this does not know how to check organisations.
Set env variable ``PLONE_RELEASER_CHECK_PYPI_ACCESS=0`` if you want to disable it.
Also, we do not check PyPI if the user is `__token__`, so using an API token.
[maurits] (#50)
2.0.0 (2023-02-23)
------------------
Breaking changes:
- Require Python 3.8+.
Cleanup code and dependencies, with help op plone/meta.
Drop support for Plone 5.2 releases: no launchpad code anymore.
[maurits] (#200)
1.8.8 (2022-12-21)
------------------
Bug fixes:
- Fix ValueError when calling ``bin/manage launchpad 5.2.10.1``.
[maurits] (#45)
1.8.7 (2022-09-07)
------------------
Bug fixes:
- report: add sleep and start parameters.
[maurits] (#44)
1.8.6 (2022-01-19)
------------------
Bug fixes:
- Insert buildout:docs-directory when reading sources.
Workaround for issue similar to `mr.roboto 89 <https://github.com/plone/mr.roboto/issues/89>`_.
[maurits] (#89)
1.8.5 (2021-12-01)
------------------
Bug fixes:
- Fix InterpolationMissingOptionError when parsing coredev 6.0 sources.
[maurits] (#42)
1.8.4 (2021-10-16)
------------------
Bug fixes:
- Do not offer updating core branches 4.3 and 5.1.
Only 5.2 and 6.0 are maintained.
[maurits] (#41)
1.8.3 (2021-01-09)
------------------
Bug fixes:
- When reporting interesting commits, catch errors when comparing with previously ignored commit.
Fixes `issue 39 <https://github.com/plone/plone.releaser/issues/39>`_.
[maurits] (#39)
1.8.2 (2020-06-26)
------------------
New features:
- Support env var PLONE_RELEASER_MULTI_PACKAGES to signal doing multiple releases.
We still change `checkouts.cfg` and `versions.cfg` in the relevant coredev branches then,
but we do not offer to push them.
[maurits] (#37)
Bug fixes:
- Fixed detecting changes in packages that are missing from checkouts.
[maurits] (#35)
1.8.1 (2020-03-08)
------------------
Bug fixes:
- Fixed adding a package to checkouts.cfg. [maurits] (#30)
- Ask before pushing an updated version when running 'report'. [maurits] (#32)
1.8.0 (2019-11-25)
------------------
New features:
- Handle coredev branch 6.0 when releasing packages.
[maurits] (#27)
Bug fixes:
- Fixed adding some package versions twice when releasing.
[maurits] (#24)
1.7.3 (2019-08-29)
------------------
Bug fixes:
- Fixed Python 3 compatibility. [maurits] (#25)
1.7.2 (2019-02-13)
------------------
No significant changes.
1.7.1 (2018-12-14)
------------------
Bug fixes:
- Python 3 compatibility fix for xmlrpclib/xmlrpc import differences. [esteele]
(#21)
- Fix pypi URL. [gforcada] (#23)
1.7.0 (2018-10-01)
------------------
New features:
- Require ``zestreleaser.towncrier``. And start using towncrier for our own
``CHANGES.rst``. [maurits] (#17)
1.7.0 (unreleased)
------------------
New features:
- New zest.releaser hook: update other buildout.coredev branches as well.
This automates the manual bookkeeping that one has to do whenever releasing packages:
i.e. to check if the package just released is also checked out and used in other buildout.coredev branches.
[gforcada]
- Ensure that selected packages are always kept on checkouts.cfg.
[gforcada]
1.5.5 (2017-10-17)
------------------
Bug fixes:
- Skip over broken version definitions when building the unified changelog.
[esteele]
1.5.4 (2016-11-01)
------------------
Bug fixes:
- Use print as a function.
[gforcada]
1.5.3 (2016-06-27)
------------------
Bug fixes:
- Change pypi-url from http to https.
[fgrcon]
1.5.2 (2016-06-12)
------------------
New features:
- Ask before pushing to coredev, after updating the checkouts and versions. [maurits]
Bug fixes:
- Fix new versions if they had dev/post release suffix.
[gforcada]
1.5.1 (2016-04-28)
------------------
New features:
- Changed new headings to 'Breaking changes', 'New features', 'Bug
fixes'. Old headers are still accepted, but in the postrelease we
generate the new ones. In the unified changelog, we combine the old
and new names.
See https://github.com/plone/Products.CMFPlone/issues/1323
[maurits]
Bug fixes:
- When compiling changelog, treat Incompatibilities header as special
too. [maurits]
1.5.0 (2016-02-27)
------------------
New:
- Added prerelease hooks to cleanup empty headers. [maurits]
- Add header 'Incompatibilities:' in postrelease. In prerelease check
if at least one of New, Fixes, Incompatibilities is there.
See https://github.com/plone/Products.CMFPlone/issues/1323 [maurits]
1.4 (2016-02-11)
----------------
New:
- Removed our 'show changelog' entry point. Required zest.releaser
6.6.0 that has this itself. [maurits]
- Show ``New:`` and ``Fixes:`` in unified changelog. [maurits]
- Require ``New:`` or ``Fixes:`` to be present in the changelog during
prerelease.
[maurits]
- Simplified showing last changelog entries. Requires zest.releaser
6.0 or higher.
[maurits]
- Set new changelog format during postrelease. Adapt check in
prerelease that warns when the original changelog text has not been
changed since the previous release.
Issue https://github.com/plone/Products.CMFPlone/issues/1180
[maurits]
Fixes:
- Temporarily require simplejson. This is needed because launchpadlib
requires lazr.restfulclient which needs a new release. See
https://bugs.launchpad.net/lazr.restfulclient/+bug/1500460 [maurits]
1.3 (2015-09-27)
----------------
- Fail nicely if a Plone versions.cfg can't be located
[esteele]
- When showing the changelog, accept 1.7.2.1 as version. So loose
version numbers instead of strict version numbers with only one or
two dots.
[maurits]
- Run git pull on buildout.coredev to make sure it is up-to-date.
[timo]
- Refactor checkPackageForUpdates to be more flexible. Made it a class
on its own module.
[gforcada]
- Create a jenkins report based on checkPackageForUpdates.
[gforcada]
1.2 (2015-03-21)
----------------
- Rename esteele.manager to plone.releaser.
[timo]
1.1 (2014-04-23)
----------------
- add feature: add the package to the version file if it doesn't exists
[jfroche]
- add command to set the package version in a versions config file
[jfroche]
- return the new version number when appending jenkins build number to the versions of a package
[jfroche]
1.0 (2014-04-23)
----------------
- Initial release
[esteele]
Raw data
{
"_id": null,
"home_page": "https://github.com/plone/plone.releaser",
"name": "plone.releaser",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "plone release",
"author": "Eric Steele",
"author_email": "eric@esteele.net",
"download_url": "https://files.pythonhosted.org/packages/73/99/3e36cceacc14caf8c6379920ff291d01cf08c022fdd2f65191e7ce5b0030/plone.releaser-2.2.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\nTools to make managing Plone core releases easier.\n\nInstallation\n------------\n\nTo install plone.releaser add it to your buildout::\n\n [release]\n recipe = zc.recipe.egg\n eggs = plone.releaser\n\nTo make it available in buildout.coredev, run buildout with releaser.cfg::\n\n $ bin/buildout -c releaser.cfg\n\nUsage\n-----\n\nCheck PyPi access to all Plone packages for a certain user::\n\n $ bin/manage checkPypi timo\n\nCheck a package for updates::\n\n $ bin/manage checkPackageForUpdates Products.CMFPlone\n\nReport packages with changes::\n\n $ bin/manage report --interactive\n\nPulls::\n\n $ bin/manage pulls\n\nChangelog::\n\n $ bin/manage changelog\n\nCheck checkout::\n\n $ bin/manage check-checkout\n\nChangelog\n=========\n\n.. You should *NOT* be adding new change log entries to this file.\n You should create a file in the news directory instead.\n For helpful instructions, please see:\n https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst\n\n.. towncrier release notes start\n\n2.2.2 (2024-04-16)\n------------------\n\nBug fixes:\n\n\n- Preserve the case of package names in versions2constraints and friends.\n [maurits] (#65)\n\n\n2.2.1 (2023-12-14)\n------------------\n\nBug fixes:\n\n\n- Manage changelog: read markdown files as well.\n [maurits] (#48)\n\n\n2.2.0 (2023-11-30)\n------------------\n\nNew features:\n\n\n- Add bin/manage versions2constraints command.\n [maurits] (#3670)\n\n\nBug fixes:\n\n\n- Fix setting version for non-lowercase package.\n In the previous release this would add a duplicate line.\n [maurits] (#58)\n- Fix missing changelog entries when running ``bin/manage changelog``.\n [maurits] (#60)\n\n\n2.1.1 (2023-09-14)\n------------------\n\nBug fixes:\n\n\n- Commit all changed files when updating a package version.\n We were only adding `versions.cfg` to the commit, but the change can be in `versions-extra.cfg`, or in the future also in `constraints.txt`.\n [maurits] (#57)\n\n\n2.1.0 (2023-09-14)\n------------------\n\nNew features:\n\n\n- Enable updating versions in pip constraints files.\n [maurits] (#53)\n- Enable updating checkouts in mxdex.ini files.\n [maurits] (#53)\n\n\nBug fixes:\n\n\n- Check all ``versions*.cfg`` files when updating a pin.\n [maurits] (#52)\n- Removed no longer working ``pulls`` command that I have never used.\n Removed ``PyGithub`` and ``keyring`` dependencies that were only used for this.\n Removed ``Source.path`` property that was only used for this.\n [maurits] (#56)\n\n\nInternal:\n\n\n- Update configuration files.\n [plone devs] (a7c2b777)\n\n\n2.0.1 (2023-06-22)\n------------------\n\nBug fixes:\n\n\n- Allow disabling PyPI rights check, as this does not know how to check organisations.\n Set env variable ``PLONE_RELEASER_CHECK_PYPI_ACCESS=0`` if you want to disable it.\n Also, we do not check PyPI if the user is `__token__`, so using an API token.\n [maurits] (#50)\n\n\n2.0.0 (2023-02-23)\n------------------\n\nBreaking changes:\n\n\n- Require Python 3.8+.\n Cleanup code and dependencies, with help op plone/meta.\n Drop support for Plone 5.2 releases: no launchpad code anymore.\n [maurits] (#200)\n\n\n1.8.8 (2022-12-21)\n------------------\n\nBug fixes:\n\n\n- Fix ValueError when calling ``bin/manage launchpad 5.2.10.1``.\n [maurits] (#45)\n\n\n1.8.7 (2022-09-07)\n------------------\n\nBug fixes:\n\n\n- report: add sleep and start parameters.\n [maurits] (#44)\n\n\n1.8.6 (2022-01-19)\n------------------\n\nBug fixes:\n\n\n- Insert buildout:docs-directory when reading sources.\n Workaround for issue similar to `mr.roboto 89 <https://github.com/plone/mr.roboto/issues/89>`_.\n [maurits] (#89)\n\n\n1.8.5 (2021-12-01)\n------------------\n\nBug fixes:\n\n\n- Fix InterpolationMissingOptionError when parsing coredev 6.0 sources.\n [maurits] (#42)\n\n\n1.8.4 (2021-10-16)\n------------------\n\nBug fixes:\n\n\n- Do not offer updating core branches 4.3 and 5.1.\n Only 5.2 and 6.0 are maintained.\n [maurits] (#41)\n\n\n1.8.3 (2021-01-09)\n------------------\n\nBug fixes:\n\n\n- When reporting interesting commits, catch errors when comparing with previously ignored commit.\n Fixes `issue 39 <https://github.com/plone/plone.releaser/issues/39>`_.\n [maurits] (#39)\n\n\n1.8.2 (2020-06-26)\n------------------\n\nNew features:\n\n\n- Support env var PLONE_RELEASER_MULTI_PACKAGES to signal doing multiple releases.\n We still change `checkouts.cfg` and `versions.cfg` in the relevant coredev branches then,\n but we do not offer to push them.\n [maurits] (#37)\n\n\nBug fixes:\n\n\n- Fixed detecting changes in packages that are missing from checkouts.\n [maurits] (#35)\n\n\n1.8.1 (2020-03-08)\n------------------\n\nBug fixes:\n\n\n- Fixed adding a package to checkouts.cfg. [maurits] (#30)\n- Ask before pushing an updated version when running 'report'. [maurits] (#32)\n\n\n1.8.0 (2019-11-25)\n------------------\n\nNew features:\n\n\n- Handle coredev branch 6.0 when releasing packages.\n [maurits] (#27)\n\n\nBug fixes:\n\n\n- Fixed adding some package versions twice when releasing.\n [maurits] (#24)\n\n\n1.7.3 (2019-08-29)\n------------------\n\nBug fixes:\n\n\n- Fixed Python 3 compatibility. [maurits] (#25)\n\n\n1.7.2 (2019-02-13)\n------------------\n\nNo significant changes.\n\n\n1.7.1 (2018-12-14)\n------------------\n\nBug fixes:\n\n\n- Python 3 compatibility fix for xmlrpclib/xmlrpc import differences. [esteele]\n (#21)\n- Fix pypi URL. [gforcada] (#23)\n\n\n1.7.0 (2018-10-01)\n------------------\n\nNew features:\n\n\n- Require ``zestreleaser.towncrier``. And start using towncrier for our own\n ``CHANGES.rst``. [maurits] (#17)\n\n\n1.7.0 (unreleased)\n------------------\n\nNew features:\n\n- New zest.releaser hook: update other buildout.coredev branches as well.\n This automates the manual bookkeeping that one has to do whenever releasing packages:\n i.e. to check if the package just released is also checked out and used in other buildout.coredev branches.\n [gforcada]\n\n- Ensure that selected packages are always kept on checkouts.cfg.\n [gforcada]\n\n\n1.5.5 (2017-10-17)\n------------------\n\nBug fixes:\n\n- Skip over broken version definitions when building the unified changelog.\n [esteele]\n\n\n1.5.4 (2016-11-01)\n------------------\n\nBug fixes:\n\n- Use print as a function.\n [gforcada]\n\n1.5.3 (2016-06-27)\n------------------\n\nBug fixes:\n\n- Change pypi-url from http to https.\n [fgrcon]\n\n\n1.5.2 (2016-06-12)\n------------------\n\nNew features:\n\n- Ask before pushing to coredev, after updating the checkouts and versions. [maurits]\n\nBug fixes:\n\n- Fix new versions if they had dev/post release suffix.\n [gforcada]\n\n\n1.5.1 (2016-04-28)\n------------------\n\nNew features:\n\n- Changed new headings to 'Breaking changes', 'New features', 'Bug\n fixes'. Old headers are still accepted, but in the postrelease we\n generate the new ones. In the unified changelog, we combine the old\n and new names.\n See https://github.com/plone/Products.CMFPlone/issues/1323\n [maurits]\n\nBug fixes:\n\n- When compiling changelog, treat Incompatibilities header as special\n too. [maurits]\n\n\n1.5.0 (2016-02-27)\n------------------\n\nNew:\n\n- Added prerelease hooks to cleanup empty headers. [maurits]\n\n- Add header 'Incompatibilities:' in postrelease. In prerelease check\n if at least one of New, Fixes, Incompatibilities is there.\n See https://github.com/plone/Products.CMFPlone/issues/1323 [maurits]\n\n\n1.4 (2016-02-11)\n----------------\n\nNew:\n\n- Removed our 'show changelog' entry point. Required zest.releaser\n 6.6.0 that has this itself. [maurits]\n\n- Show ``New:`` and ``Fixes:`` in unified changelog. [maurits]\n\n- Require ``New:`` or ``Fixes:`` to be present in the changelog during\n prerelease.\n [maurits]\n\n- Simplified showing last changelog entries. Requires zest.releaser\n 6.0 or higher.\n [maurits]\n\n- Set new changelog format during postrelease. Adapt check in\n prerelease that warns when the original changelog text has not been\n changed since the previous release.\n Issue https://github.com/plone/Products.CMFPlone/issues/1180\n [maurits]\n\nFixes:\n\n- Temporarily require simplejson. This is needed because launchpadlib\n requires lazr.restfulclient which needs a new release. See\n https://bugs.launchpad.net/lazr.restfulclient/+bug/1500460 [maurits]\n\n\n1.3 (2015-09-27)\n----------------\n\n- Fail nicely if a Plone versions.cfg can't be located\n [esteele]\n\n- When showing the changelog, accept 1.7.2.1 as version. So loose\n version numbers instead of strict version numbers with only one or\n two dots.\n [maurits]\n\n- Run git pull on buildout.coredev to make sure it is up-to-date.\n [timo]\n\n- Refactor checkPackageForUpdates to be more flexible. Made it a class\n on its own module.\n [gforcada]\n\n- Create a jenkins report based on checkPackageForUpdates.\n [gforcada]\n\n\n1.2 (2015-03-21)\n----------------\n\n- Rename esteele.manager to plone.releaser.\n [timo]\n\n\n1.1 (2014-04-23)\n----------------\n\n- add feature: add the package to the version file if it doesn't exists\n [jfroche]\n\n- add command to set the package version in a versions config file\n [jfroche]\n\n- return the new version number when appending jenkins build number to the versions of a package\n [jfroche]\n\n\n1.0 (2014-04-23)\n----------------\n\n- Initial release\n [esteele]\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Plone release management utilities",
"version": "2.2.2",
"project_urls": {
"Homepage": "https://github.com/plone/plone.releaser"
},
"split_keywords": [
"plone",
"release"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07a560f48a8c8b803ddfcdeed824bbb73882506c2a47da9f87ddd90a17a56c7c",
"md5": "eb3058fd5d4df810cf80f5ebb617b224",
"sha256": "b02e9f09bb020e6660adbfbcf305955686dfeb45ca0c28a6ebdc36087fc3578c"
},
"downloads": -1,
"filename": "plone.releaser-2.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb3058fd5d4df810cf80f5ebb617b224",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 44517,
"upload_time": "2024-04-16T19:35:38",
"upload_time_iso_8601": "2024-04-16T19:35:38.930603Z",
"url": "https://files.pythonhosted.org/packages/07/a5/60f48a8c8b803ddfcdeed824bbb73882506c2a47da9f87ddd90a17a56c7c/plone.releaser-2.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "73993e36cceacc14caf8c6379920ff291d01cf08c022fdd2f65191e7ce5b0030",
"md5": "ea986b479c7bd84c8463f2a1701d5542",
"sha256": "67cb7effb5390584ec4ed0ed022ab3dc8d9b4d93f3c82f850908685535d20a6c"
},
"downloads": -1,
"filename": "plone.releaser-2.2.2.tar.gz",
"has_sig": false,
"md5_digest": "ea986b479c7bd84c8463f2a1701d5542",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 41064,
"upload_time": "2024-04-16T19:35:42",
"upload_time_iso_8601": "2024-04-16T19:35:42.926936Z",
"url": "https://files.pythonhosted.org/packages/73/99/3e36cceacc14caf8c6379920ff291d01cf08c022fdd2f65191e7ce5b0030/plone.releaser-2.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 19:35:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plone",
"github_project": "plone.releaser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "plone.releaser"
}
JSON
