Skip to content

Commit

Permalink
Update the balena.yml docs to mention full semver support
Browse files Browse the repository at this point in the history
Change-type: minor
  • Loading branch information
thgreasi committed Dec 18, 2024
1 parent 628432c commit e679bd1
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions pages/learn/deploy/deploy-with-balena-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The file should be named `balena.yml` and be located in the root of the project
```yaml
name: balenaSound
type: sw.application
version: 3.5.2
description: >-
Build a single or multi-room streamer for an existing audio device using a
Raspberry Pi! Supports Bluetooth, Airplay and Spotify Connect
Expand All @@ -70,7 +71,6 @@ data:
- raspberrypi4-64
- fincm3
- intel-nuc
version: 3.5.2
```
- `type` - Required field. In most cases this would be `sw.application`, unless you are implementing a block, in which case you need to use `sw.block`. For reference, check [balena.yml file for a block][create-your-block].
Expand All @@ -86,19 +86,15 @@ version: 3.5.2
- `applicationConfigVariables` - [Configuration variables][configuration] allow you to provide runtime configuration to the host OS and supervisor. These variables all begin with `BALENA_` or `RESIN_`.
- `defaultDeviceType` - The device type that will be pre-selected in the "Create fleet" modal. It defaults to Raspberry Pi 4 if not provided. You can find a list of [device types](/reference/hardware/devices/) here.
- `supportedDeviceType` - The device types that the fleet supports. You can find a list of [device types](/reference/hardware/devices/) here.
- `version` - A user-defined release version value in the 3-digit format "1.2.3" that is
- `version` - A user-defined [semver version](https://semver.org/) for the release that is
shown in the Version column of the Releases page of the balenaCloud web dashboard, and
which may also be queried through the balena API `release.semver` field. Currently only
the 3 core _major.minor.patch_ semver digits may be defined by the user (i.e. no support
for user-defined pre-release or metadata [semver syntax](https://semver.org/)). We plan
to support the full semver syntax in user-defined version values in the future. If the
version value follows the 3-digit format "1.2.3" and multiple deployments are made with
the same version value, the balena API automatically increases the revision number in
the format "1.2.3+rev1", "1.2.3+rev2", "1.2.3+rev3" and so on. Version values that do
**not** follow the 3-digit format are deprecated and may cause deployments to fail in
the future. Currently, a deployment may succeed with such a non-compliant version value
as long as the value is unique across all releases in the fleet, however the web
dashboard will display version `0.0.0`.
which may also be queried through the balena API `release.semver` field. If multiple
deployments are made with the same version value, the balena API automatically increases
the revision number in the format "1.2.3+rev1", "1.2.3+rev2", "1.2.3+rev3" and so on.
Using version values that are **not** [semver compliant](https://semver.org/) is deprecated
and may cause deployments to fail in the future. Currently, a deployment may succeed
with such a non-compliant version value as long as the value is unique across all releases
in the fleet, however the web dashboard will display version `0.0.0`.

[balenahub]:{{ $links.balenaHubUrl }}
[configuration]:/learn/manage/configuration
Expand Down

0 comments on commit e679bd1

Please sign in to comment.