mirror of
https://seed.radicle.dev/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5.git
synced 2026-11-12 06:30:36 +08:00
Alexis Sellier
3bd5589b1a
> I'm going to be making a set of breaking changes to COBs in order to stabilize the data formats. This is hopefully a one-time change that bundles various breaking changes. All COBs have been reworked: issue, patch, id. The changes included are: * Revise the assign and tag actions to take a single list of assignees/tags to set, instead of an "add" and a "remove" list. This makes API usage simpler when editing issues, and simplifies the apply function * Rename "tags" to "labels", and the tag action to label. This is because tag is confusing in the context of git, as it could mean a git tag. Using label removes that confusion. * Use DIDs instead of PublicKeys for assignees -- this is more future-proof * Modify the manifest file format in the COB tree. Mainly, remove the `history_type` key which is redundant, and use camelCase for keys * Flatten the `Thread` actions into the parent action type * Ensure that operations on redacted objects do not fail, since redactions could have happened concurrently * Use a consistent naming scheme for actions, using `.` as separator * Consolidate comment types and remove `CodeComment`, by adding an optional `location` field to `Comment` * Add many placeholder actions that are not yet implemented To preserve backwards compatibility, a `legacy` module is created with the old `apply` function. When loading the manifest, we check whether it is a legacy COB or a "stable" COB, and in the legacy case, use the legacy code to materialize the state and then convert the object into the stable type. Eventually, we'll delete the legacy code.
118 lines
4.8 KiB
Markdown
118 lines
4.8 KiB
Markdown
Let's look at how patch updates work.
|
|
|
|
Alice creates a project and Bob clones it.
|
|
|
|
``` ~alice
|
|
$ rad init --name heartwood --description "radicle heartwood protocol & stack" --no-confirm --announce
|
|
|
|
Initializing radicle 👾 project in .
|
|
|
|
✓ Project heartwood created
|
|
✓ Syncing inventory..
|
|
✓ Announcing inventory..
|
|
|
|
Your project's Repository ID (RID) is rad:zhbMU4DUXrzB8xT6qAJh6yZ7bFMK.
|
|
You can show it any time by running `rad .`
|
|
```
|
|
|
|
``` ~bob
|
|
$ rad clone rad:zhbMU4DUXrzB8xT6qAJh6yZ7bFMK
|
|
✓ Tracking relationship established for rad:zhbMU4DUXrzB8xT6qAJh6yZ7bFMK with scope 'all'
|
|
✓ Fetching rad:zhbMU4DUXrzB8xT6qAJh6yZ7bFMK from z6MknSL…StBU8Vi..
|
|
✓ Forking under z6Mkt67…v4N1tRk..
|
|
✓ Creating checkout in ./heartwood..
|
|
✓ Remote alice@z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi added
|
|
✓ Remote-tracking branch alice@z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi/master created for z6MknSL…StBU8Vi
|
|
✓ Repository successfully cloned under [..]/heartwood/
|
|
```
|
|
|
|
We wait for Alice to sync our fork.
|
|
|
|
``` ~bob
|
|
$ rad node events -n 1 --timeout 1
|
|
{"type":"refsSynced","remote":"z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi","rid":"rad:zhbMU4DUXrzB8xT6qAJh6yZ7bFMK"}
|
|
```
|
|
|
|
Bob then opens a patch.
|
|
|
|
``` ~bob (stderr)
|
|
$ cd heartwood
|
|
$ git checkout -b bob/feature -q
|
|
$ git commit --allow-empty -m "Bob's commit #1" -q
|
|
$ git push rad -o sync -o patch.message="Bob's patch" HEAD:refs/patches
|
|
✓ Patch 26e3e563ddc7df8dd0c9f81274c0b3cb1b764568 opened
|
|
✓ Synced with 1 node(s)
|
|
To rad://zhbMU4DUXrzB8xT6qAJh6yZ7bFMK/z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk
|
|
* [new reference] HEAD -> refs/patches
|
|
```
|
|
``` ~bob
|
|
$ git status --short --branch
|
|
## bob/feature...rad/patches/26e3e563ddc7df8dd0c9f81274c0b3cb1b764568
|
|
```
|
|
|
|
Alice checks it out.
|
|
|
|
``` ~alice
|
|
$ rad patch checkout 26e3e56
|
|
✓ Switched to branch patch/26e3e56
|
|
✓ Branch patch/26e3e56 setup to track rad/patches/26e3e563ddc7df8dd0c9f81274c0b3cb1b764568
|
|
$ git show
|
|
commit bdcdb30b3c0f513620dd0f1c24ff8f4f71de956b
|
|
Author: radicle <radicle@localhost>
|
|
Date: Thu Dec 15 17:28:04 2022 +0000
|
|
|
|
Bob's commit #1
|
|
```
|
|
|
|
Bob then updates the patch.
|
|
|
|
``` ~bob (stderr)
|
|
$ git commit --allow-empty -m "Bob's commit #2" -q
|
|
$ git push rad -o sync -o patch.message="Updated."
|
|
✓ Patch 26e3e56 updated to c04ef81bad734c65a7d5834cefcdd60c4f0484f7
|
|
✓ Synced with 1 node(s)
|
|
To rad://zhbMU4DUXrzB8xT6qAJh6yZ7bFMK/z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk
|
|
bdcdb30..cad2666 bob/feature -> patches/26e3e563ddc7df8dd0c9f81274c0b3cb1b764568
|
|
```
|
|
|
|
Alice pulls the update.
|
|
|
|
``` ~alice
|
|
$ rad patch show 26e3e56
|
|
╭──────────────────────────────────────────────────────────────────────────────╮
|
|
│ Title Bob's patch │
|
|
│ Patch 26e3e563ddc7df8dd0c9f81274c0b3cb1b764568 │
|
|
│ Author did:key:z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk │
|
|
│ Head cad2666a8a2250e4dee175ed5044be2c251ff08b │
|
|
│ Commits ahead 2, behind 0 │
|
|
│ Status open │
|
|
├──────────────────────────────────────────────────────────────────────────────┤
|
|
│ cad2666 Bob's commit #2 │
|
|
│ bdcdb30 Bob's commit #1 │
|
|
├──────────────────────────────────────────────────────────────────────────────┤
|
|
│ ● opened by bob (z6Mkt67…v4N1tRk) [ ... ] │
|
|
│ ↑ updated to c04ef81bad734c65a7d5834cefcdd60c4f0484f7 (cad2666) [ ... ] │
|
|
╰──────────────────────────────────────────────────────────────────────────────╯
|
|
$ git ls-remote rad
|
|
f2de534b5e81d7c6e2dcaf58c3dd91573c0a0354 refs/heads/master
|
|
cad2666a8a2250e4dee175ed5044be2c251ff08b refs/heads/patches/26e3e563ddc7df8dd0c9f81274c0b3cb1b764568
|
|
```
|
|
``` ~alice
|
|
$ git fetch rad
|
|
$ git status --short --branch
|
|
## patch/26e3e56...rad/patches/26e3e563ddc7df8dd0c9f81274c0b3cb1b764568 [behind 1]
|
|
```
|
|
``` ~alice
|
|
$ git pull
|
|
Updating bdcdb30..cad2666
|
|
Fast-forward
|
|
```
|
|
``` ~alice
|
|
$ git show
|
|
commit cad2666a8a2250e4dee175ed5044be2c251ff08b
|
|
Author: radicle <radicle@localhost>
|
|
Date: Thu Dec 15 17:28:04 2022 +0000
|
|
|
|
Bob's commit #2
|
|
```
|