unison/unison-src/transcripts/release-draft-command.output.md
Greg Pfeil 0031542faf
Add a space before code block info strings
This is for consistency with the `cmark` style. Now the blocks we still
pretty-print ourselves will match the bulk of them that `cmark`
produces.
2024-07-10 13:56:07 -06:00

1.3 KiB

The release.draft command drafts a release from the current branch.

Some setup:

someterm = 18

  Loading changes detected in scratch.u.

  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

foo/main> add

  ⍟ I've added these definitions:
  
    someterm : Nat

Now, the release.draft demo:

release.draft accepts a single semver argument.

foo/main> release.draft 1.2.3

  😎 Great! I've created a draft release for you at
  /releases/drafts/1.2.3.
  
  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.
  
  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
       `switch /releases/drafts/1.2.3`.

It's an error to try to create a releases/drafts/x.y.z branch that already exists.

foo/main> release.draft 1.2.3

  foo/releases/drafts/1.2.3 already exists. You can switch to it
  with `switch foo/releases/drafts/1.2.3`.