doc: document generating releases via tags (#2302)

This commit is contained in:
Scott Morrison 2023-07-14 01:39:54 +10:00 committed by GitHub
parent 4562e8d9a2
commit 7213ff0065
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -57,3 +57,10 @@ You might find that debugging through elan, e.g. via `gdb lean`, disables some
things like symbol autocompletion because at first only the elan proxy binary
is loaded. You can instead pass the explicit path to `bin/lean` in your build
folder to gdb, or use `gdb $(elan which lean)`.
It is also possible to generate releases that others can use,
simply by pushing a tag to your fork of the Lean 4 github repository
(and waiting about an hour; check the `Actions` tab for completion).
If you push `my-tag` to a fork in your github account `my_name`,
you can then put `my_name/lean4:my-tag` in your `lean-toolchain` file in a project using `lake`.
(You must use a tag name that does not start with a numeral, or contain `_`).