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

Commit

Permalink
Add config example
Browse files Browse the repository at this point in the history
  • Loading branch information
ssbarnea committed Feb 7, 2024
1 parent f6d5d2c commit dd2c238
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 15 deletions.
1 change: 0 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ ci:
skip:
# https://github.com/pre-commit-ci/issues/issues/55
- pip-compile
- schemas
submodules: true
exclude: >
(?x)^(
Expand Down
37 changes: 23 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
# gh-pre

An experimental tool that helps with Project Release Engineering, focused on
repository clusters (groups of repositories which need to be released in
repository clusters (groups of repositories that need to be released in
particular order).

```shell
gh extension install pycontribs/gh-pre
```

Usage:
## 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
Expand All @@ -20,15 +41,3 @@ It can also be installed and executed as a Python package:
pip install gh-pre
pre
```

## Configuration

Please create a `~/pre.yml` config file with content similar to:

```
repos:
- github-org/project1
- github-org/project2
```

This will tell it which repositories to check for draft releases.

0 comments on commit dd2c238

Please sign in to comment.