mirror of
https://seed.radicle.dev/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5.git
synced 2026-11-04 02:40:32 +08:00
Fintan Halpenny
498da296fd
Previously, the head of the opened patch would not be displayed, and so the user could not tell what it was if any updates were applied. Show the head for the opened revision. The below shows the difference between before and after, respectively: ``` ├─────────────────────────────────────────────────────────────────────┤ │ ● opened by z6MknSL…StBU8Vi (you) now │ │ ↑ updated to 8d6692ce2b2219a54d09ccd5feefedb2bae33eba (02bef3f) now │ │ ↑ updated to 8438ab3940316abe65c93982a0a8f39688400359 (9304dbc) now │ ╰─────────────────────────────────────────────────────────────────────╯ ``` ``` ├─────────────────────────────────────────────────────────────────────┤ │ ● opened by z6MknSL…StBU8Vi (you) (8b0ea80) now │ │ ↑ updated to 8d6692ce2b2219a54d09ccd5feefedb2bae33eba (02bef3f) now │ │ ↑ updated to 8438ab3940316abe65c93982a0a8f39688400359 (9304dbc) now │ ╰─────────────────────────────────────────────────────────────────────╯ ``` Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com> X-Clacks-Overhead: GNU Terry Pratchett
211 lines
13 KiB
Markdown
211 lines
13 KiB
Markdown
When contributing to another's project, it is common for the contribution to be
|
|
of many commits and involve a discussion with the project's maintainer. This is supported
|
|
via Radicle's patches.
|
|
|
|
Here we give a brief overview for using patches in our hypothetical car
|
|
scenario. It turns out instructions containing the power requirements were
|
|
missing from the project.
|
|
|
|
```
|
|
$ git checkout -b flux-capacitor-power
|
|
$ touch REQUIREMENTS
|
|
```
|
|
|
|
Here the instructions are added to the project's README for 1.21 gigawatts and
|
|
commit the changes to git.
|
|
|
|
```
|
|
$ git add REQUIREMENTS
|
|
$ git commit -v -m "Define power requirements"
|
|
[flux-capacitor-power 3e674d1] Define power requirements
|
|
1 file changed, 0 insertions(+), 0 deletions(-)
|
|
create mode 100644 REQUIREMENTS
|
|
```
|
|
|
|
Once the code is ready, we open (or create) a patch with our changes for the project.
|
|
|
|
``` (stderr)
|
|
$ git push rad -o patch.message="Define power requirements" -o patch.message="See details." HEAD:refs/patches
|
|
✓ Patch 6ff4f09c1b5a81347981f59b02ef43a31a07cdae opened
|
|
To rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji/z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi
|
|
* [new reference] HEAD -> refs/patches
|
|
```
|
|
|
|
It will now be listed as one of the project's open patches.
|
|
|
|
```
|
|
$ rad patch
|
|
╭─────────────────────────────────────────────────────────────────────────────────────────╮
|
|
│ ● ID Title Author Head + - Updated │
|
|
├─────────────────────────────────────────────────────────────────────────────────────────┤
|
|
│ ● 6ff4f09 Define power requirements z6MknSL…StBU8Vi (you) 3e674d1 +0 -0 now │
|
|
╰─────────────────────────────────────────────────────────────────────────────────────────╯
|
|
```
|
|
```
|
|
$ rad patch show 6ff4f09c1b5a81347981f59b02ef43a31a07cdae -p
|
|
╭────────────────────────────────────────────────────╮
|
|
│ Title Define power requirements │
|
|
│ Patch 6ff4f09c1b5a81347981f59b02ef43a31a07cdae │
|
|
│ Author z6MknSL…StBU8Vi (you) │
|
|
│ Head 3e674d1a1df90807e934f9ae5da2591dd6848a33 │
|
|
│ Branches flux-capacitor-power │
|
|
│ Commits ahead 1, behind 0 │
|
|
│ Status open │
|
|
│ │
|
|
│ See details. │
|
|
├────────────────────────────────────────────────────┤
|
|
│ 3e674d1 Define power requirements │
|
|
├────────────────────────────────────────────────────┤
|
|
│ ● opened by z6MknSL…StBU8Vi (you) (3e674d1) now │
|
|
╰────────────────────────────────────────────────────╯
|
|
|
|
commit 3e674d1a1df90807e934f9ae5da2591dd6848a33
|
|
Author: radicle <radicle@localhost>
|
|
Date: Thu Dec 15 17:28:04 2022 +0000
|
|
|
|
Define power requirements
|
|
|
|
diff --git a/REQUIREMENTS b/REQUIREMENTS
|
|
new file mode 100644
|
|
index 0000000..e69de29
|
|
|
|
```
|
|
|
|
We can also list only patches that we've authored.
|
|
|
|
```
|
|
$ rad patch list --authored
|
|
╭─────────────────────────────────────────────────────────────────────────────────────────╮
|
|
│ ● ID Title Author Head + - Updated │
|
|
├─────────────────────────────────────────────────────────────────────────────────────────┤
|
|
│ ● 6ff4f09 Define power requirements z6MknSL…StBU8Vi (you) 3e674d1 +0 -0 now │
|
|
╰─────────────────────────────────────────────────────────────────────────────────────────╯
|
|
```
|
|
|
|
We can also see that it set an upstream for our patch branch:
|
|
```
|
|
$ git branch -vv
|
|
* flux-capacitor-power 3e674d1 [rad/patches/6ff4f09c1b5a81347981f59b02ef43a31a07cdae] Define power requirements
|
|
master f2de534 [rad/master] Second commit
|
|
```
|
|
|
|
We can also label patches as well as assign DIDs to the patch to help
|
|
organise your workflow:
|
|
|
|
```
|
|
$ rad patch label 6ff4f09 --add fun --no-announce
|
|
$ rad patch assign 6ff4f09 --add did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi --no-announce
|
|
$ rad patch show 6ff4f09
|
|
╭────────────────────────────────────────────────────╮
|
|
│ Title Define power requirements │
|
|
│ Patch 6ff4f09c1b5a81347981f59b02ef43a31a07cdae │
|
|
│ Author z6MknSL…StBU8Vi (you) │
|
|
│ Labels fun │
|
|
│ Head 3e674d1a1df90807e934f9ae5da2591dd6848a33 │
|
|
│ Branches flux-capacitor-power │
|
|
│ Commits ahead 1, behind 0 │
|
|
│ Status open │
|
|
│ │
|
|
│ See details. │
|
|
├────────────────────────────────────────────────────┤
|
|
│ 3e674d1 Define power requirements │
|
|
├────────────────────────────────────────────────────┤
|
|
│ ● opened by z6MknSL…StBU8Vi (you) (3e674d1) now │
|
|
╰────────────────────────────────────────────────────╯
|
|
```
|
|
|
|
Wait, let's add a README too! Just for fun.
|
|
|
|
```
|
|
$ touch README.md
|
|
$ git add README.md
|
|
$ git commit --message "Add README, just for the fun"
|
|
[flux-capacitor-power 27857ec] Add README, just for the fun
|
|
1 file changed, 0 insertions(+), 0 deletions(-)
|
|
create mode 100644 README.md
|
|
```
|
|
``` (stderr)
|
|
$ git push rad -o patch.message="Add README, just for the fun"
|
|
✓ Patch 6ff4f09 updated to revision e0fd9f00b51e10e1ca88868e68e46e859ed371d7
|
|
To rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji/z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi
|
|
3e674d1..27857ec flux-capacitor-power -> patches/6ff4f09c1b5a81347981f59b02ef43a31a07cdae
|
|
```
|
|
|
|
And let's leave a quick comment for our team:
|
|
|
|
```
|
|
$ rad patch comment 6ff4f09 --message 'I cannot wait to get back to the 90s!' --no-announce
|
|
╭───────────────────────────────────────╮
|
|
│ z6MknSL…StBU8Vi (you) now f5b4613 │
|
|
│ I cannot wait to get back to the 90s! │
|
|
╰───────────────────────────────────────╯
|
|
$ rad patch comment 6ff4f09 --message 'My favorite decade!' --reply-to f5b4613 -q --no-announce
|
|
611df66ccb3803b604a59f2efa9a42d72256dd49
|
|
```
|
|
|
|
Now, let's checkout the patch that we just created:
|
|
|
|
```
|
|
$ rad patch checkout 6ff4f09
|
|
✓ Switched to branch patch/6ff4f09
|
|
✓ Branch patch/6ff4f09 setup to track rad/patches/6ff4f09c1b5a81347981f59b02ef43a31a07cdae
|
|
```
|
|
|
|
We can also add a review verdict as such:
|
|
|
|
```
|
|
$ rad patch review 6ff4f09 --accept --no-message --no-announce
|
|
✓ Patch 6ff4f09 accepted
|
|
```
|
|
|
|
Showing the patch list now will reveal the favorable verdict:
|
|
|
|
```
|
|
$ rad patch show 6ff4f09
|
|
╭─────────────────────────────────────────────────────────────────────╮
|
|
│ Title Define power requirements │
|
|
│ Patch 6ff4f09c1b5a81347981f59b02ef43a31a07cdae │
|
|
│ Author z6MknSL…StBU8Vi (you) │
|
|
│ Labels fun │
|
|
│ Head 27857ec9eb04c69cacab516e8bf4b5fd36090f66 │
|
|
│ Branches flux-capacitor-power, patch/6ff4f09 │
|
|
│ Commits ahead 2, behind 0 │
|
|
│ Status open │
|
|
│ │
|
|
│ See details. │
|
|
├─────────────────────────────────────────────────────────────────────┤
|
|
│ 27857ec Add README, just for the fun │
|
|
│ 3e674d1 Define power requirements │
|
|
├─────────────────────────────────────────────────────────────────────┤
|
|
│ ● opened by z6MknSL…StBU8Vi (you) (3e674d1) now │
|
|
│ ↑ updated to e0fd9f00b51e10e1ca88868e68e46e859ed371d7 (27857ec) now │
|
|
│ └─ ✓ accepted by z6MknSL…StBU8Vi (you) now │
|
|
╰─────────────────────────────────────────────────────────────────────╯
|
|
```
|
|
|
|
If you make a mistake on the patch description, you can always change it!
|
|
|
|
```
|
|
$ rad patch edit 6ff4f09 --message "Define power requirements" --message "Add requirements file" --no-announce
|
|
$ rad patch show 6ff4f09
|
|
╭─────────────────────────────────────────────────────────────────────╮
|
|
│ Title Define power requirements │
|
|
│ Patch 6ff4f09c1b5a81347981f59b02ef43a31a07cdae │
|
|
│ Author z6MknSL…StBU8Vi (you) │
|
|
│ Labels fun │
|
|
│ Head 27857ec9eb04c69cacab516e8bf4b5fd36090f66 │
|
|
│ Branches flux-capacitor-power, patch/6ff4f09 │
|
|
│ Commits ahead 2, behind 0 │
|
|
│ Status open │
|
|
│ │
|
|
│ Add requirements file │
|
|
├─────────────────────────────────────────────────────────────────────┤
|
|
│ 27857ec Add README, just for the fun │
|
|
│ 3e674d1 Define power requirements │
|
|
├─────────────────────────────────────────────────────────────────────┤
|
|
│ ● opened by z6MknSL…StBU8Vi (you) (3e674d1) now │
|
|
│ ↑ updated to e0fd9f00b51e10e1ca88868e68e46e859ed371d7 (27857ec) now │
|
|
│ └─ ✓ accepted by z6MknSL…StBU8Vi (you) now │
|
|
╰─────────────────────────────────────────────────────────────────────╯
|
|
```
|