2023-04-28 22:05:31 +03:00
|
|
|
The `release.draft` command drafts a release from the current branch.
|
|
|
|
|
|
|
|
Some setup:
|
|
|
|
|
2024-07-10 17:46:18 +03:00
|
|
|
``` unison
|
2023-04-28 22:05:31 +03:00
|
|
|
someterm = 18
|
|
|
|
```
|
|
|
|
|
2024-07-10 19:17:15 +03:00
|
|
|
``` ucm
|
2023-04-28 22:05:31 +03:00
|
|
|
|
2023-12-22 14:55:24 +03:00
|
|
|
Loading changes detected in scratch.u.
|
|
|
|
|
2023-04-28 22:05:31 +03:00
|
|
|
I found and typechecked these definitions in scratch.u. If you
|
|
|
|
do an `add` or `update`, here's how your codebase would
|
|
|
|
change:
|
|
|
|
|
|
|
|
⍟ These new definitions are ok to `add`:
|
|
|
|
|
|
|
|
someterm : Nat
|
|
|
|
|
|
|
|
```
|
2024-07-10 19:17:15 +03:00
|
|
|
``` ucm
|
2023-04-28 22:05:31 +03:00
|
|
|
foo/main> add
|
|
|
|
|
|
|
|
⍟ I've added these definitions:
|
|
|
|
|
|
|
|
someterm : Nat
|
|
|
|
|
|
|
|
```
|
|
|
|
Now, the `release.draft` demo:
|
|
|
|
|
|
|
|
`release.draft` accepts a single semver argument.
|
|
|
|
|
2024-07-10 19:17:15 +03:00
|
|
|
``` ucm
|
2023-04-28 22:05:31 +03:00
|
|
|
foo/main> release.draft 1.2.3
|
|
|
|
|
|
|
|
😎 Great! I've created a draft release for you at
|
|
|
|
/releases/drafts/1.2.3.
|
|
|
|
|
2023-05-01 17:29:50 +03:00
|
|
|
You can create a `ReleaseNotes : Doc` in this branch to give
|
|
|
|
an overview of the release. It'll automatically show up on
|
|
|
|
Unison Share when you publish.
|
2023-04-28 22:05:31 +03:00
|
|
|
|
|
|
|
When ready to release 1.2.3 to the world, `push` the release
|
|
|
|
to Unison Share, navigate to the release, and click "Publish".
|
|
|
|
|
|
|
|
Tip: if you get pulled away from drafting your release, you
|
|
|
|
can always get back to it with
|
2023-05-02 01:24:55 +03:00
|
|
|
`switch /releases/drafts/1.2.3`.
|
2023-04-28 22:05:31 +03:00
|
|
|
|
|
|
|
```
|
|
|
|
It's an error to try to create a `releases/drafts/x.y.z` branch that already exists.
|
|
|
|
|
2024-07-10 19:17:15 +03:00
|
|
|
``` ucm
|
2023-04-28 22:05:31 +03:00
|
|
|
foo/main> release.draft 1.2.3
|
|
|
|
|
2023-09-08 17:05:50 +03:00
|
|
|
foo/releases/drafts/1.2.3 already exists. You can switch to it
|
2023-12-15 21:02:49 +03:00
|
|
|
with `switch foo/releases/drafts/1.2.3`.
|
2023-04-28 22:05:31 +03:00
|
|
|
|
|
|
|
```
|