Skip to content
This repository has been archived by the owner on Jun 18, 2024. It is now read-only.

Commit

Permalink
Update README.md (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
ssbarnea authored Jun 18, 2024
1 parent 8a6dc34 commit f0bfd2c
Showing 1 changed file with 1 addition and 43 deletions.
44 changes: 1 addition & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/

0 comments on commit f0bfd2c

Please sign in to comment.