Skip to content

Commit 0b950f4

Browse files
authored
Merge pull request coollabsio#3396 from peaklabs-dev/add-release.md
Feat: Add RELEASE.md
2 parents 8712af7 + 3f3bf07 commit 0b950f4

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

RELEASE.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Coolify Release Guide
2+
3+
This guide outlines the release process for Coolify, intended for developers and those interested in understanding how releases are managed and deployed.
4+
5+
## Release Process
6+
7+
1. **Development on `next` or separate branches**
8+
- Changes, fixes and new features are developed on the `next` or even separate branches.
9+
10+
2. **Merging to `main`**
11+
- Once changes are ready, they are merged from `next` into the `main` branch.
12+
13+
3. **Building the release**
14+
- After merging to `main`, a new release is built.
15+
- Note: A push to `main` does not automatically mean a new version is released.
16+
17+
4. **Creating a GitHub release**
18+
- A new release is created on GitHub with the new version details.
19+
20+
5. **Updating the CDN**
21+
- The final step is updating the version information on the CDN:
22+
[https://cdn.coollabs.io/coolify/versions.json](https://cdn.coollabs.io/coolify/versions.json)
23+
24+
> [!NOTE]
25+
> The CDN update may not occur immediately after the GitHub release. It can happen hours or even days later due to additional testing, stability checks, or potential hotfixes.
26+
27+
28+
## Version Availability
29+
30+
It's important to understand that a new version released on GitHub may not immediately become available for users to update (through manual or auto-update).
31+
32+
> [!IMPORTANT]
33+
> If you see a new release on GitHub but haven't received the update, it's likely because the CDN hasn't been updated yet. This is intentional and ensures stability and allows for hotfixes before the new version is officially released.
34+
35+
## Manually Update to Specific Versions
36+
37+
> [!CAUTION]
38+
> Updating to unreleased versions is not recommended and may cause issues. Use at your own risk!
39+
40+
To update your Coolify instance to a specific (unreleased) version, use the following command:
41+
42+
```bash
43+
curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash -s <version>
44+
```
45+
-> Replace `<version>` with the version you want to update to (for example `4.0.0-beta.332`).

0 commit comments

Comments
 (0)