185 lines
7.0 KiB
Markdown
185 lines
7.0 KiB
Markdown
Well known COBs, for example issues and patches, can not only be showed via porcelain commands such as
|
|
`rad issue show` and `rad patch show`, but also using the plumbing command `rad cob show`.
|
|
While humans likely prefer to use `rad issue show` and `rad patch show`, this command makes integration
|
|
with other software components easier.
|
|
|
|
First create an issue.
|
|
|
|
```
|
|
$ rad issue open --title "spice harvester broken" --description "Fremen have attacked, maybe we went too far?" --no-announce
|
|
╭──────────────────────────────────────────────────╮
|
|
│ Title spice harvester broken │
|
|
│ Issue 9de644864342d7a505eb8d58d1ef20e5bb05de2e │
|
|
│ Author alice (you) │
|
|
│ Status open │
|
|
│ │
|
|
│ Fremen have attacked, maybe we went too far? │
|
|
╰──────────────────────────────────────────────────╯
|
|
```
|
|
|
|
The issue is now listed under our project.
|
|
|
|
```
|
|
$ rad issue list
|
|
╭─────────────────────────────────────────────────────────────────────────────────────╮
|
|
│ ● ID Title Author Labels Assignees Opened │
|
|
├─────────────────────────────────────────────────────────────────────────────────────┤
|
|
│ ● 9de6448 spice harvester broken alice (you) now │
|
|
╰─────────────────────────────────────────────────────────────────────────────────────╯
|
|
```
|
|
|
|
Let's create a patch, too.
|
|
|
|
```
|
|
$ git checkout -b spice-harvester-broken
|
|
$ touch TREATY.md
|
|
$ git add TREATY.md
|
|
$ git commit -v -m "Start drafting peace treaty"
|
|
[spice-harvester-broken 575ed68] Start drafting peace treaty
|
|
1 file changed, 0 insertions(+), 0 deletions(-)
|
|
create mode 100644 TREATY.md
|
|
$ git push rad -o patch.message="Start drafting peace treaty" -o patch.message="See details." HEAD:refs/patches
|
|
```
|
|
|
|
Patch can be listed.
|
|
|
|
```
|
|
$ rad patch
|
|
╭───────────────────────────────────────────────────────────────────────────────────────────╮
|
|
│ ● ID Title Author Reviews Head + - Updated │
|
|
├───────────────────────────────────────────────────────────────────────────────────────────┤
|
|
│ ● d1f7f86 Start drafting peace treaty alice (you) - 575ed68 +0 -0 now │
|
|
╰───────────────────────────────────────────────────────────────────────────────────────────╯
|
|
```
|
|
|
|
Both issue and patch COBs can be listed.
|
|
|
|
```
|
|
$ rad cob list --repo rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --type xyz.radicle.issue
|
|
9de644864342d7a505eb8d58d1ef20e5bb05de2e
|
|
$ rad cob list --repo rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --type xyz.radicle.patch
|
|
d1f7f869fde9fac19c1779c4c2e77e8361333f91
|
|
```
|
|
|
|
We can show the issue COB.
|
|
|
|
```
|
|
$ rad cob show --repo rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --type xyz.radicle.issue --object 9de644864342d7a505eb8d58d1ef20e5bb05de2e
|
|
{
|
|
"assignees": [],
|
|
"title": "spice harvester broken",
|
|
"state": {
|
|
"status": "open"
|
|
},
|
|
"labels": [],
|
|
"thread": {
|
|
"comments": {
|
|
"9de644864342d7a505eb8d58d1ef20e5bb05de2e": {
|
|
"author": "z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi",
|
|
"reactions": [],
|
|
"resolved": false,
|
|
"body": "Fremen have attacked, maybe we went too far?",
|
|
"edits": [
|
|
{
|
|
"author": "z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi",
|
|
"timestamp": 1671125284000,
|
|
"body": "Fremen have attacked, maybe we went too far?",
|
|
"embeds": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"timeline": [
|
|
"9de644864342d7a505eb8d58d1ef20e5bb05de2e"
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
We can show the patch COB too.
|
|
|
|
```
|
|
$ rad cob show --repo rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --type xyz.radicle.patch --object d1f7f869fde9fac19c1779c4c2e77e8361333f91
|
|
{
|
|
"title": "Start drafting peace treaty",
|
|
"author": {
|
|
"id": "did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi"
|
|
},
|
|
"state": {
|
|
"status": "open"
|
|
},
|
|
"target": "delegates",
|
|
"labels": [],
|
|
"merges": {},
|
|
"revisions": {
|
|
"d1f7f869fde9fac19c1779c4c2e77e8361333f91": {
|
|
"id": "d1f7f869fde9fac19c1779c4c2e77e8361333f91",
|
|
"author": {
|
|
"id": "did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi"
|
|
},
|
|
"description": [
|
|
{
|
|
"author": "z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi",
|
|
"timestamp": 1671125284000,
|
|
"body": "See details.",
|
|
"embeds": []
|
|
}
|
|
],
|
|
"base": "f2de534b5e81d7c6e2dcaf58c3dd91573c0a0354",
|
|
"oid": "575ed68c716d6aae81ea6b718fd9ac66a8eae532",
|
|
"discussion": {
|
|
"comments": {},
|
|
"timeline": []
|
|
},
|
|
"reviews": {},
|
|
"timestamp": 1671125284000,
|
|
"resolves": [],
|
|
"reactions": []
|
|
}
|
|
},
|
|
"assignees": [],
|
|
"timeline": [
|
|
"d1f7f869fde9fac19c1779c4c2e77e8361333f91"
|
|
],
|
|
"reviews": {}
|
|
}
|
|
```
|
|
|
|
Finally let's update the issue and see the output of `rad cob show` also changes.
|
|
|
|
```
|
|
$ rad issue label 9de6448 --add bug --no-announce
|
|
$ rad cob show --repo rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --type xyz.radicle.issue --object 9de644864342d7a505eb8d58d1ef20e5bb05de2e
|
|
{
|
|
"assignees": [],
|
|
"title": "spice harvester broken",
|
|
"state": {
|
|
"status": "open"
|
|
},
|
|
"labels": [
|
|
"bug"
|
|
],
|
|
"thread": {
|
|
"comments": {
|
|
"9de644864342d7a505eb8d58d1ef20e5bb05de2e": {
|
|
"author": "z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi",
|
|
"reactions": [],
|
|
"resolved": false,
|
|
"body": "Fremen have attacked, maybe we went too far?",
|
|
"edits": [
|
|
{
|
|
"author": "z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi",
|
|
"timestamp": 1671125284000,
|
|
"body": "Fremen have attacked, maybe we went too far?",
|
|
"embeds": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"timeline": [
|
|
"9de644864342d7a505eb8d58d1ef20e5bb05de2e"
|
|
]
|
|
}
|
|
}
|
|
```
|