Merge pull request 'Update README' (#15) from 14-readme into master
All checks were successful
test / test (push) Successful in 33s
build / build (push) Successful in 2m4s

Reviewed-on: #15
This commit is contained in:
Torjus Håkestad 2024-10-07 20:07:29 +00:00
commit 4bc78716ee
2 changed files with 19 additions and 8 deletions

View File

@ -5,15 +5,26 @@ Nixpkgs PR status checker.
## Example
```console
$ nixprstatus 345501
$ nixprstatus pr 345501
ktailctl: 0.18.0 -> 0.18.1
✅ merged
✅ master
nixos-unstable-small
nixos-unstable
nixos-unstable-small
nixos-unstable
❌ nixos-24.05
$ nixprstatus --help
Usage: python -m nixprstatus [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or
customize the installation.
--help Show this message and exit.
Commands:
pr Get merge status of pull request.
since Return the count of commits that has happened between the two refs.
```
## TODO
* Support backported commits
* JSON output

View File

@ -21,7 +21,7 @@ def pr(
list[str] | None, typer.Option(help="Check specific branch")
] = None,
):
"""Get status of pull request"""
"""Get merge status of pull request."""
console = Console()
if branches: