Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation about the new version branches #1748

Merged
merged 3 commits into from
Jul 16, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,37 @@ main

After creating a new test you need to still call it from the `Main` module by adding it to `IHP/Test/Main.hs`.

## Branches

Since the switch to nix flakes with IHP v1.1 we're using release branches, to make it easy to upgrade IHP versions using `nix flake update`.

E.g. there's a [branch named `v1.1`](https://github.com/digitallyinduced/ihp/tree/v1.1) that contains the latest IHP v1.1.x release. When a new IHP v1.1.x release is made, we'll update the `v1.1` branch to point to the new release commit.

IHP apps have a `flake.nix` like this:

```nix
{
inputs.ihp.url = "github:digitallyinduced/ihp/v1.1";
}
```

This means that whenever someone runs `nix flake update`, they'll get the latest commit from the IHP v1.1 branch.
mpscholten marked this conversation as resolved.
Show resolved Hide resolved

To upgrade to a newer minor version, the URL can be changed to use IHP from the e.g. `v1.2` branch:

```nix
{
inputs.ihp.url = "github:digitallyinduced/ihp/v1.2";
}
```

mpscholten marked this conversation as resolved.
Show resolved Hide resolved
### New Releases

When we're preparing a new release, e.g. the IHP v1.2.0 release, we'll create a new branch `v1.2` and merge the current master into that branch.

Additionally every released version of IHP is tagged. [You can see a list of all tags on GitHub.](https://github.com/digitallyinduced/ihp/tags)


## Troubleshooting

### `can't satisfy package ihp`
Expand Down