mirror of
https://seed.radicle.dev/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5.git
synced 2026-11-09 21:30:29 +08:00
Fintan Halpenny
82a53e3a53
The fetch V2 improvements introduced a `UserInfo` type that is used to set the Git config's name and email when cloning a repository. This `UserInfo` can also be used when creating a new `Repository`. The `Storage` type now takes a `UserInfo` so that it can be passed to `Repository::create`, for creating a new repository. For testing, this requires adding a new `fixtures::user` so that testing `Storage` instances can be easily constructed. It also means that the `radicle-cli` tests all changed with new SHAs since the name and email are used as part of the hashing input. N.b. the order of the timelines while testing the identity cob changed. It's not clear why that is. Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com> X-Clacks-Overhead: GNU Terry Pratchett
173 lines
9.7 KiB
Markdown
173 lines
9.7 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) 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 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
|
|
```
|
|
|
|
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 0c0942e2ff2488617d950ede15567ca39a29972e
|
|
To rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji/z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi
|
|
3e674d1..27857ec flux-capacitor-power -> patches/6ff4f09c1b5a81347981f59b02ef43a31a07cdae
|
|
```
|
|
|
|
And let's leave a quick comment for our team:
|
|
|
|
```
|
|
$ rad patch comment 6ff4f09c1b5a81347981f59b02ef43a31a07cdae --message 'I cannot wait to get back to the 90s!'
|
|
╭───────────────────────────────────────╮
|
|
│ z6MknSL…StBU8Vi (you) now cd811db │
|
|
│ I cannot wait to get back to the 90s! │
|
|
╰───────────────────────────────────────╯
|
|
$ rad patch comment 6ff4f09c1b5a81347981f59b02ef43a31a07cdae --message 'My favorite decade!' --reply-to cd811db -q
|
|
b6a76fe394de87eb34cbc3823a0edc80ff98cb97
|
|
```
|
|
|
|
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 review 6ff4f09c1b5a81347981f59b02ef43a31a07cdae --accept --no-message --no-sync
|
|
✓ 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) │
|
|
│ 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) now │
|
|
│ ↑ updated to 0c0942e2ff2488617d950ede15567ca39a29972e (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"
|
|
$ rad patch show 6ff4f09
|
|
╭─────────────────────────────────────────────────────────────────────╮
|
|
│ Title Define power requirements │
|
|
│ Patch 6ff4f09c1b5a81347981f59b02ef43a31a07cdae │
|
|
│ Author z6MknSL…StBU8Vi (you) │
|
|
│ 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) now │
|
|
│ ↑ updated to 0c0942e2ff2488617d950ede15567ca39a29972e (27857ec) now │
|
|
│ ✓ accepted by z6MknSL…StBU8Vi (you) now │
|
|
╰─────────────────────────────────────────────────────────────────────╯
|
|
```
|