Skip to content

Commit

Permalink
doc/index: explain the concept of release branches
Browse files Browse the repository at this point in the history
  • Loading branch information
minijackson committed Jun 5, 2024
1 parent c52318c commit 342c159
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,25 @@ However, since EPNix is a git repository, you will be able, through Nix, to use
```{=html}
<!-- TODO: link to an explanation, from the IOC side, and from the NixOS side -->
```

## The epics-base package

The epics-base package has no significant modification compared to the upstream version at [Launchpad].
One goal of EPNix is to keep those modifications to a minimum, and upstream what's possible.

# Release branches

EPNix has a `master` branch,
which is considered unstable,
meaning breaking changes might happen without notice.

EPNix also has release branches,
such as `nixos-23.11`,
tied to the nixpkgs release branches,
where breaking changes are forbidden.

Backporting changes to older release branches is done on a "best-effort" basis.

------------------------------------------------------------------------

This documentation follows the [Diátaxis] documentation framework.
Expand Down

0 comments on commit 342c159

Please sign in to comment.