The RepoPlone is a tool designed to manage mono repos containing a repository.toml configuration file at the repository root.

It provides various commands to streamline repository management, versioning, and release processes.

To use the latest version of this tool, run the command:

uvx repoplone

We use uv to make the release, please make sure authentication is in place by setting the environment variable UV_PUBLISH_TOKEN:

export UV_PUBLISH_TOKEN=<MYTOKEN>

or by using the uv auth command, as explained here.

npm whoami

To add releases to GitHub, you should have an environment variable GH_TOKEN set -- with a valid token -- before running this tool.

export GH_TOKEN='<token>'

Ensure that your monorepo contains a repository.toml file. Below is an example of such a configuration:

[repository]
name = "fake-distribution"
changelog = "CHANGELOG.md"
version = "version.txt"
version_format = "semver"
compose = ["docker-compose.yml"]

[repository.towncrier]
section = "Project"
settings = "towncrier.toml"

[backend.package]
name = "fake.distribution"
path = "backend"
changelog = "backend/CHANGELOG.md"
towncrier_settings = "backend/pyproject.toml"
base_package = "Products.CMFPlone"
publish = false

[frontend.package]
name = "fake-distribution"
path = "frontend/packages/fake-distribution"
changelog = "frontend/packages/fake-distribution/CHANGELOG.md"
towncrier_settings = "frontend/packages/fake-distribution/towncrier.toml"
publish = false

To see all available commands, run:

uvx repoplone

To check the installed version of the tool, use:

uvx repoplone --version

List current versions for:

• Repository
• Backend package
• Frontend package

uvx repoplone versions current

Report next version of all components of this repository:

• Repository
• Backend package
• Frontend package

uvx repoplone versions next

Report version information for major dependencies:

• Backend base package
• Frontend base package
• Frontend @plone/volto package

uvx repoplone versions dependencies

To generate and display the draft changelog, run:

uvx repoplone changelog

The release command creates a new release and accepts the following arguments:

The version argument defines the new version to be used in the release. It can be a specific version number or a version segment. Below is a reference table showing how version segments modify an existing 1.0.0 version:

Use this flag to simulate the release process without actually publishing the new version.

Example:

uvx repoplone release a

This will create an alpha release.

The following commands are available exclusively for projects managed by UV and with a base_package set in the [backend.package] section of repository.toml.

To check which is the current base package, run:

uvx repoplone deps info

To check the current base package version, run:

uvx repoplone deps check

To upgrade the base package to a specific version, use:

uvx repoplone deps upgrade 6.1.1

We welcome contributions to RepoPlone.

You can create an issue in the issue tracker, or contact a maintainer.

• Issue Tracker
• Source Code

• uv

Clone this repository:

git clone [email protected]:plone/repoplone.git

Install UV, and create a local virtual environment with the following command.

make install

uv run repoplone

make check

pytest is this package's test runner.

Run all tests with the following command.

make test

Run all tests, but stop on the first error and open a pdb session with the following command.

uv run pytest -x --pdb

Run only tests that match test_release_backend with the following command.

uv run pytest -k test_release_backend

Run only tests that match test_release_backend, but stop on the first error and open a pdb session with the following command.

uv run pytest -k test_release_backend -x --pdb

We use mypy to run static type checking for this codebase.

Run the checker with the following command.

uv run mypy src

For support, questions, or more detailed documentation, visit the official RepoPlone repository.

The project is released under the MIT License.