From a3caad239cac4695b29769fdfdef77f7c55ecea5 Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Wed, 11 Sep 2024 14:09:15 +0200 Subject: [PATCH 1/3] Feat: release.md file --- RELEASE.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 000000000..d362eceaa --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,46 @@ +# Coolify Release Guide + +This guide outlines the release process for Coolify, intended for developers and those interested in understanding how releases are managed and deployed. + +## Release Process + +1. **Development on `next` branch** + - Changes and new features are developed on the `next` or even separate branches. + +2. **Merging to `main`** + - Once changes are ready, they are merged from `next` into the `main` branch. + +3. **Building the release** + - After merging to `main`, a new release is built. + - Note: A push to `main` does not automatically mean a new version is released. + +4. **Creating a GitHub release** + - A new release is created on GitHub, which generates new version images. + - Note: This does not mean the version is released. + +5. **Updating the CDN** + - The final step is updating the version information on the CDN: + [https://cdn.coollabs.io/coolify/versions.json](https://cdn.coollabs.io/coolify/versions.json) + +> [!NOTE] +> 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. + + +## Version Availability + +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). + +> [!IMPORTANT] +> 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. + +### Manually Update to Specific Versions + +> [!WARNING] +> Updating to unreleased versions is not recommended and may cause issues. Use at your own risk! + +To update your Coolify instance to a specific (unreleased) version, use the following command: + +```bash +curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash -s +``` +-> Replace `` with the version you want to update to (for example `4.0.0-beta.332`). \ No newline at end of file From 6498e5b6f01aebac8cf02f3e8a73e35517d75c30 Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Wed, 11 Sep 2024 14:16:25 +0200 Subject: [PATCH 2/3] Update RELEASE.md --- RELEASE.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index d362eceaa..8c0ff0b41 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -4,8 +4,8 @@ This guide outlines the release process for Coolify, intended for developers and ## Release Process -1. **Development on `next` branch** - - Changes and new features are developed on the `next` or even separate branches. +1. **Development on `next` or separate branches** + - Changes, fixes and new features are developed on the `next` or even separate branches. 2. **Merging to `main`** - Once changes are ready, they are merged from `next` into the `main` branch. @@ -15,8 +15,7 @@ This guide outlines the release process for Coolify, intended for developers and - Note: A push to `main` does not automatically mean a new version is released. 4. **Creating a GitHub release** - - A new release is created on GitHub, which generates new version images. - - Note: This does not mean the version is released. + - A new release is created on GitHub with the new version details. 5. **Updating the CDN** - The final step is updating the version information on the CDN: @@ -35,7 +34,7 @@ It's important to understand that a new version released on GitHub may not immed ### Manually Update to Specific Versions -> [!WARNING] +> [!CAUTION] > Updating to unreleased versions is not recommended and may cause issues. Use at your own risk! To update your Coolify instance to a specific (unreleased) version, use the following command: @@ -43,4 +42,4 @@ To update your Coolify instance to a specific (unreleased) version, use the foll ```bash curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash -s ``` --> Replace `` with the version you want to update to (for example `4.0.0-beta.332`). \ No newline at end of file +-> Replace `` with the version you want to update to (for example `4.0.0-beta.332`). From 3f3bf075fa80b7d313d6b36e49f500242c78d202 Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Wed, 11 Sep 2024 14:18:10 +0200 Subject: [PATCH 3/3] Update RELEASE.md --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 8c0ff0b41..2cb96b72b 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -32,7 +32,7 @@ It's important to understand that a new version released on GitHub may not immed > [!IMPORTANT] > 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. -### Manually Update to Specific Versions +## Manually Update to Specific Versions > [!CAUTION] > Updating to unreleased versions is not recommended and may cause issues. Use at your own risk!