@bensandee/forgejo-cli 0.1.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -12
- package/dist/bin.mjs +6081 -1471
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# @bensandee/forgejo-cli
|
|
2
2
|
|
|
3
|
-
`bst-fj`: the Forgejo API commands, without the rest of `bst`.
|
|
4
|
-
`@bensandee/tooling`'s `bst` bin.
|
|
3
|
+
`bst-fj`: the Forgejo API commands, without the rest of `bst`. Most of these commands used to ship on
|
|
4
|
+
`@bensandee/tooling`'s `bst` bin; `issue:*`, `pr:create` and `pr:update` still do, and run the same code.
|
|
5
5
|
|
|
6
6
|
## Installation
|
|
7
7
|
|
|
@@ -38,15 +38,26 @@ run should get every variable from its environment and leave `BST_ENV_FILE` unse
|
|
|
38
38
|
Run `bst-fj --help` for the list and `bst-fj <command> --help` for each command's flags. Every
|
|
39
39
|
command takes `--json`, which prints exactly one JSON document, failures included.
|
|
40
40
|
|
|
41
|
-
| Command
|
|
42
|
-
|
|
|
43
|
-
| `labels`
|
|
44
|
-
| `secrets`
|
|
45
|
-
| `webhooks`
|
|
46
|
-
| `release:create`
|
|
47
|
-
| `pr:checks`
|
|
48
|
-
| `pr:list`
|
|
49
|
-
| `commit:status`
|
|
41
|
+
| Command | What it does |
|
|
42
|
+
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
43
|
+
| `labels` | `list` a repository's labels, or `sync` one named set from a `--file` (creates and updates, never deletes) |
|
|
44
|
+
| `secrets` | `set`, `list` or `delete` Forgejo Actions secrets |
|
|
45
|
+
| `webhooks` | List webhooks across an instance (system, user, org and repo) |
|
|
46
|
+
| `release:create` | Create a release for a tag the forge already has; refuses a tag the forge lacks unless given `--target` |
|
|
47
|
+
| `pr:checks` | Read a pull request's CI verdict, optionally `--wait` for it to settle |
|
|
48
|
+
| `pr:list` | List a repository's pull requests |
|
|
49
|
+
| `commit:status` | Read the status checks for a commit SHA, branch, tag or git ref |
|
|
50
|
+
| `issue:*` | `view`, `list`, `comment`, `create`, `update`, `download`, `label`, `unlabel`, `set-labels`, `close`, `reopen` |
|
|
51
|
+
| `pr:create` | Push the current branch and open a pull request, deriving the title and body when none is given |
|
|
52
|
+
| `pr:update` | Push the current branch and update its open pull request |
|
|
53
|
+
| `branch:list` | List a repository's branches |
|
|
54
|
+
| `branch:delete` | Delete a branch through the API; reports the forge's reason when it refuses |
|
|
55
|
+
| `pr:files` | List the files a pull request changes |
|
|
56
|
+
| `pr:merge` | Merge an open, non-draft, mergeable PR pinned to the head it read; refuses closed, draft, conflicted, unconfirmed or non-green checks (zero statuses included) unless `--ignore-checks`; `--delete-branch` is opt-in |
|
|
57
|
+
| `workflow:dispatch` | Dispatch a workflow with `--workflow`, `--ref` and repeatable `--input`; takes `--repo owner/repo`, not a URL |
|
|
58
|
+
| `ci:runs` | List a repository's workflow runs with their jobs, filtered by workflow, ref, pull request, head SHA or status |
|
|
59
|
+
| `ci:log` | Print one workflow job's whole log, or with `--grep` only the lines whose text matches |
|
|
50
60
|
|
|
51
61
|
Zero posted statuses reads as `no-status`, never as green. Every command is Forgejo-only: on
|
|
52
|
-
GitHub, use `gh`.
|
|
62
|
+
GitHub, use `gh`. The `issue:*`, `pr:create` and `pr:update` commands take the same flags and print the
|
|
63
|
+
same `--json` documents as `bst`'s, except that `issue:create` has no config default for assignees.
|