From f0bfd2c39ff03a049570c73bda3f9d88c856b52e Mon Sep 17 00:00:00 2001 From: Sorin Sbarnea Date: Tue, 18 Jun 2024 13:04:29 +0100 Subject: [PATCH] Update README.md (#13) --- README.md | 44 +------------------------------------------- 1 file changed, 1 insertion(+), 43 deletions(-) diff --git a/README.md b/README.md index c593d39..b3eccbc 100644 --- a/README.md +++ b/README.md @@ -1,43 +1 @@ -# gh-pre - -An experimental tool that helps with Project Release Engineering, focused on -repository clusters (groups of repositories that need to be released in -particular order). - -```shell -gh extension install pycontribs/gh-pre -``` - -## Configuration - -To use the tool you need to configure the list of repositories it needs to check on each run: - -```yaml -# ~/pre.yml -repos: - - ansible/ansible-compat - - ansible/ansible-lint - - ansible/ansible-navigator - - ansible/ansible-creator - - ansible/molecule - - ansible/tox-ansible - - ansible/pytest-ansible - - ansible/ansible-development-environment - - ansible/ansible-dev-tools - - ansible/creator-ee -``` - -This will tell it which repositories to check for draft releases. - -## Usage - -```shell -gh pre -``` - -It can also be installed and executed as a Python package: - -```shell -pip install gh-pre -pre -``` +Project now part of https://mk.readthedocs.io/multirepo/