Merge pull request 'Update README' (#15) from 14-readme into master
Reviewed-on: #15
This commit is contained in:
commit
4bc78716ee
25
README.md
25
README.md
@ -5,15 +5,26 @@ Nixpkgs PR status checker.
|
|||||||
## Example
|
## Example
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ nixprstatus 345501
|
$ nixprstatus pr 345501
|
||||||
|
ktailctl: 0.18.0 -> 0.18.1
|
||||||
|
|
||||||
|
✅ merged
|
||||||
✅ master
|
✅ master
|
||||||
❌ nixos-unstable-small
|
✅ nixos-unstable-small
|
||||||
❌ nixos-unstable
|
✅ nixos-unstable
|
||||||
❌ nixos-24.05
|
❌ 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
|
|
||||||
|
@ -21,7 +21,7 @@ def pr(
|
|||||||
list[str] | None, typer.Option(help="Check specific branch")
|
list[str] | None, typer.Option(help="Check specific branch")
|
||||||
] = None,
|
] = None,
|
||||||
):
|
):
|
||||||
"""Get status of pull request"""
|
"""Get merge status of pull request."""
|
||||||
console = Console()
|
console = Console()
|
||||||
|
|
||||||
if branches:
|
if branches:
|
||||||
|
Loading…
Reference in New Issue
Block a user