isle/docs/dev/releases.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2023-03-25 14:58:20 +00:00
# Releases
A release consists of:
2024-10-03 16:59:48 +00:00
- A full set of `isle` binaries for all supported platforms, compiled from the
same source.
2023-03-25 14:58:20 +00:00
- A text file containing hashes of each binary.
- A file containing a signature of the hash file, created by whoever is building
the release.
## Building
*NOTE: This has only been tested from an x86_64 linux machine*
To create a release only a functional nix installation is required. Simply run
the `./release.sh` script, and input a release name when prompted.
From here an `isle` binary will be cross-compiled for all supported
2023-03-25 14:58:20 +00:00
platforms. This will take a long time the first time you perform it on your
machine.
2024-07-07 11:37:26 +00:00
Once compilation is completed, the release will be signed using the default GPG
2023-03-25 14:58:20 +00:00
key on your machine, and you will be prompted for its password in order to
create the signature.
## Releasing
Releases are uploaded to the repository's Releases page, and release naming
follows the conventional semantic versioning system. Each release should be
accompanied by a set of changes which have occurred since the last release,
described both in the `CHANGELOG.md` file and in the description on the Release
itself.