From e415a99f71a66bae99e216a992af61da930a427a Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Tue, 17 Sep 2024 22:28:00 +0200 Subject: [PATCH 01/10] Update RELEASE.md --- RELEASE.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 51 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 2cb96b72b..f0a25b135 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -2,17 +2,26 @@ This guide outlines the release process for Coolify, intended for developers and those interested in understanding how releases are managed and deployed. +## Table of Contents +- [Release Process](#release-process) +- [Version Types](#version-types) +- [Version Availability](#version-availability) +- [Manually Update to Specific Versions](#manually-update-to-specific-versions) + ## Release Process +
+Click to expand + 1. **Development on `next` or separate branches** - - Changes, fixes and new features are developed on the `next` or even separate branches. + - Changes, fixes, and new features are developed on the `next` or 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. + - 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 with the new version details. @@ -24,16 +33,55 @@ This guide outlines the release process for Coolify, intended for developers and > [!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 Types + +
+Click to expand + +### Stable (Coming soon) +- v4.0.0 or Stable is the production version. Use this for stable, production environments. +- Updates to stable happen every 2 to 4 weeks, with hotfixes possible. +- Releases are larger but less frequent. Multiple nightly versions will eventually turn into one stable version release. + +### Nightly +- Updates are much more frequent, with weekly or sometimes even daily updates possible. +- Versioning scheme: [To be added] +- Install nightly version: + ```bash + curl -fsSL https://cdn.coollabs.io/coolify-nightly/install.sh | bash -s next + ``` + +### Beta +- Beta versions are... [To be completed] +- Versioning scheme: [To be added] + +
## 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). +
+Click to expand + +### Self-Hosted +- Updates to the self-hosted version generally happen faster and more frequently, especially when using the nightly release channel. + +> [!WARNING] +> Do not use nightly builds in production as there is no guarantee of stability. + +### Cloud +- Updates to the cloud are less frequent. The cloud version may be a few versions behind the latest release. +- This approach focuses on stability, as it is a managed service. > [!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 +
+Click to expand + > [!CAUTION] > Updating to unreleased versions is not recommended and may cause issues. Use at your own risk! From 28cde9fd508bf7058ddcce574e1c79165082d062 Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Tue, 17 Sep 2024 22:52:47 +0200 Subject: [PATCH 02/10] Update RELEASE.md --- RELEASE.md | 22 +--------------------- 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index f0a25b135..de16c531e 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -10,9 +10,6 @@ This guide outlines the release process for Coolify, intended for developers and ## Release Process -
-Click to expand - 1. **Development on `next` or separate branches** - Changes, fixes, and new features are developed on the `next` or separate branches. @@ -33,13 +30,8 @@ This guide outlines the release process for Coolify, intended for developers and > [!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 Types -
-Click to expand - ### Stable (Coming soon) - v4.0.0 or Stable is the production version. Use this for stable, production environments. - Updates to stable happen every 2 to 4 weeks, with hotfixes possible. @@ -57,13 +49,8 @@ This guide outlines the release process for Coolify, intended for developers and - Beta versions are... [To be completed] - Versioning scheme: [To be added] -
- ## Version Availability -
-Click to expand - ### Self-Hosted - Updates to the self-hosted version generally happen faster and more frequently, especially when using the nightly release channel. @@ -73,21 +60,14 @@ This guide outlines the release process for Coolify, intended for developers and ### Cloud - Updates to the cloud are less frequent. The cloud version may be a few versions behind the latest release. - This approach focuses on stability, as it is a managed service. +- @andrasbacsai will update the cloud version as soon as the fixes are released and thoroughly tested. > [!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 -
-Click to expand - > [!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: - -```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`). From 3e0a5191b956bf8dcd1990f6043a7f2d55b330b4 Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Tue, 17 Sep 2024 23:01:56 +0200 Subject: [PATCH 03/10] Update RELEASE.md --- RELEASE.md | 40 +++++++++++++++++++++++++--------------- 1 file changed, 25 insertions(+), 15 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index de16c531e..c7baf5146 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -33,9 +33,10 @@ This guide outlines the release process for Coolify, intended for developers and ## Version Types ### Stable (Coming soon) -- v4.0.0 or Stable is the production version. Use this for stable, production environments. -- Updates to stable happen every 2 to 4 weeks, with hotfixes possible. +- v4.0.0 or Stable is the production version. Use this for stable, production environments (general recommendation for everyone). +- Updates to stable happen every 2 to 4 weeks but hotfixes are possible. - Releases are larger but less frequent. Multiple nightly versions will eventually turn into one stable version release. +- Versioning scheme: Stable version is `v4.0.0` and follows semantic versioning. ### Nightly - Updates are much more frequent, with weekly or sometimes even daily updates possible. @@ -45,29 +46,38 @@ This guide outlines the release process for Coolify, intended for developers and curl -fsSL https://cdn.coollabs.io/coolify-nightly/install.sh | bash -s next ``` -### Beta -- Beta versions are... [To be completed] -- Versioning scheme: [To be added] - -## Version Availability - -### Self-Hosted -- Updates to the self-hosted version generally happen faster and more frequently, especially when using the nightly release channel. - > [!WARNING] > Do not use nightly builds in production as there is no guarantee of stability. -### Cloud -- Updates to the cloud are less frequent. The cloud version may be a few versions behind the latest release. -- This approach focuses on stability, as it is a managed service. -- @andrasbacsai will update the cloud version as soon as the fixes are released and thoroughly tested. +### Beta +- Beta versions are test releases of the next upcoming stable version. Or when a new feature is added, it will be added to the beta version first. +- Versioning scheme: [To be added] + +## Version Availability +- When a new version is relaese and new Gihtub release is created but that does not mean the version is available for your instace. Read more about version availability for different instance types below. + +### Self-Hosted +- Updates to the self-hosted version generally happen faster and more frequently, especially when using the nightly release channel. +- Self hosted users can update their instance manually in the instance settings or wait for the instance to automatically 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. +### Cloud +- Updates to the cloud are less frequent. The cloud version may be a few versions behind the latest release. +- This approach focuses on stability, as it is a managed service and the cloud version is updated to a throughly tested version before being released. +- @andrasbacsai will update the cloud version as soon as the fixes and version are thoroughly tested and cofirmed stable. + +> [!IMPORTANT] +> If you see a new release on GitHub but the cloud version is not updated, it's because the @andrasbacsai hasn't updated the cloud version yet. This is intentional and ensures stability of the cloud version. + ## Manually Update to Specific Versions > [!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: +```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`). From d6f498e6bbbe9fab512ceeb66b990f18dbbe36e5 Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Tue, 17 Sep 2024 23:05:03 +0200 Subject: [PATCH 04/10] Update RELEASE.md --- RELEASE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index c7baf5146..8ffd5118c 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -64,12 +64,12 @@ This guide outlines the release process for Coolify, intended for developers and > 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. ### Cloud -- Updates to the cloud are less frequent. The cloud version may be a few versions behind the latest release. +- Updates to the cloud are less frequent. Because the cloud version is manually updated by @andrasbacsai to a throughly tested version before being released. - This approach focuses on stability, as it is a managed service and the cloud version is updated to a throughly tested version before being released. -- @andrasbacsai will update the cloud version as soon as the fixes and version are thoroughly tested and cofirmed stable. +- @andrasbacsai will manually update the cloud version as soon as the fixes and version are thoroughly tested and confirmed stable. > [!IMPORTANT] -> If you see a new release on GitHub but the cloud version is not updated, it's because the @andrasbacsai hasn't updated the cloud version yet. This is intentional and ensures stability of the cloud version. +> If you see a new release on GitHub but the cloud version is not updated, it's because @andrasbacsai hasn't updated the cloud version yet. This is intentional and ensures stability of the cloud version. The only the you can do is to wait for the cloud version to be updated. ## Manually Update to Specific Versions From 4aed40fb6517f5bbcfb733455fde84e1c738fab4 Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Wed, 18 Sep 2024 17:15:39 +0200 Subject: [PATCH 05/10] Update RELEASE.md --- RELEASE.md | 110 +++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 77 insertions(+), 33 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 8ffd5118c..fd9331012 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -5,71 +5,114 @@ This guide outlines the release process for Coolify, intended for developers and ## Table of Contents - [Release Process](#release-process) - [Version Types](#version-types) + - [Stable](#stable) + - [Nightly](#nightly) + - [Beta](#beta) - [Version Availability](#version-availability) + - [Self-Hosted](#self-hosted) + - [Cloud](#cloud) - [Manually Update to Specific Versions](#manually-update-to-specific-versions) ## Release Process -1. **Development on `next` or separate branches** - - Changes, fixes, and new features are developed on the `next` or separate branches. +1. **Development on `next` or Feature Branches** + - Develop changes, fixes, and new features on the `next` branch or separate feature branches. 2. **Merging to `main`** - - Once changes are ready, they are merged from `next` into the `main` branch. + - Once changes are ready, merge them 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. +3. **Building the Release** + - After merging to `main`, initiate the build process for a new release. + - *Note:* Pushing to `main` does not automatically trigger a new version release. -4. **Creating a GitHub release** - - A new release is created on GitHub with the new version details. +4. **Creating a GitHub Release** + - Create a new release on GitHub with the updated version details. 5. **Updating the CDN** - - The final step is updating the version information on the CDN: + - Update 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. +> The CDN update may not occur immediately after the GitHub release. It can take hours or even days due to additional testing, stability checks, or potential hotfixes. ## Version Types -### Stable (Coming soon) -- v4.0.0 or Stable is the production version. Use this for stable, production environments (general recommendation for everyone). -- Updates to stable happen every 2 to 4 weeks but hotfixes are possible. -- Releases are larger but less frequent. Multiple nightly versions will eventually turn into one stable version release. -- Versioning scheme: Stable version is `v4.0.0` and follows semantic versioning. +
+ Stable -### Nightly -- Updates are much more frequent, with weekly or sometimes even daily updates possible. -- Versioning scheme: [To be added] -- Install nightly version: - ```bash - curl -fsSL https://cdn.coollabs.io/coolify-nightly/install.sh | bash -s next - ``` +- **Stable (v4.0.0) (Coming Soon)** + - The production version suitable for stable, production environments. + - **Update Frequency:** Every 2 to 4 weeks, with possible hotfixes. + - **Release Size:** Larger but less frequent releases. Multiple nightly versions consolidate into a single stable release. + - **Versioning Scheme:** Follows semantic versioning (e.g., `v4.0.0`). + - **Installation Command:** + ```bash + curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash + ``` + +
+ +
+ Nightly + +- **Nightly** + - Features frequent updates, potentially weekly or even daily. + - **Update Frequency:** Very high; ideal for testing the latest changes. + - **Versioning Scheme:** [To be added] + - **Installation Command:** + ```bash + curl -fsSL https://cdn.coollabs.io/coolify-nightly/install.sh | bash -s next + ``` > [!WARNING] > Do not use nightly builds in production as there is no guarantee of stability. -### Beta -- Beta versions are test releases of the next upcoming stable version. Or when a new feature is added, it will be added to the beta version first. -- Versioning scheme: [To be added] +
+ +
+ Beta + +- **Beta** + - Test releases for the upcoming stable version or new features. + - **Purpose:** Allows users to test and provide feedback on new features before they become stable. + - **Versioning Scheme:** [To be added] + - **Installation Command:** + ```bash + curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash + ``` + +
## Version Availability -- When a new version is relaese and new Gihtub release is created but that does not mean the version is available for your instace. Read more about version availability for different instance types below. + +When a new version is released and a new GitHub release is created, it does not immediately become available for your instance. Below is information on version availability for different instance types. ### Self-Hosted -- Updates to the self-hosted version generally happen faster and more frequently, especially when using the nightly release channel. -- Self hosted users can update their instance manually in the instance settings or wait for the instance to automatically update. + +- **Update Frequency:** Faster and more frequent updates, especially on the nightly release channel. +- **Update Methods:** + 1. **Manual Update in Instance Settings:** + - Navigate to `Settings > Update Check Frequency` and click the "Check Manually" button. + - An upgrade button will appear on the sidebar page if an update is available. + 2. **Automatic Update:** + - If auto-update is enabled, the instance will update automatically. + 3. **Re-run Installation Script:** + - Execute the installation script to automatically upgrade to the latest version available on the CDN. + ```bash + curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash + ``` > [!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. +> If a new release is available on GitHub but your instance hasn't updated, the CDN might not have been updated yet. This delay ensures stability and allows for hotfixes before official release. ### Cloud -- Updates to the cloud are less frequent. Because the cloud version is manually updated by @andrasbacsai to a throughly tested version before being released. -- This approach focuses on stability, as it is a managed service and the cloud version is updated to a throughly tested version before being released. -- @andrasbacsai will manually update the cloud version as soon as the fixes and version are thoroughly tested and confirmed stable. + +- **Update Frequency:** Less frequent, focusing on stability with manually tested versions. +- **Update Process:** + - Updates are managed by @andrasbacsai, who ensures that each cloud version is thoroughly tested and stable before release. > [!IMPORTANT] -> If you see a new release on GitHub but the cloud version is not updated, it's because @andrasbacsai hasn't updated the cloud version yet. This is intentional and ensures stability of the cloud version. The only the you can do is to wait for the cloud version to be updated. +> If a new GitHub release exists but the cloud version hasn't been updated, it's because @andrasbacsai hasn't released it yet. This ensures the cloud version remains stable. You'll need to wait for the update. ## Manually Update to Specific Versions @@ -77,6 +120,7 @@ This guide outlines the release process for Coolify, intended for developers and > 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 ``` From 513ca6f57d4fba55ae09386c7e746e6c33795df3 Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Wed, 18 Sep 2024 18:09:03 +0200 Subject: [PATCH 06/10] Update RELEASE.md --- RELEASE.md | 63 +++++++++++++++++++++++++++--------------------------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index fd9331012..2dd51db48 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -16,34 +16,32 @@ This guide outlines the release process for Coolify, intended for developers and ## Release Process 1. **Development on `next` or Feature Branches** - - Develop changes, fixes, and new features on the `next` branch or separate feature branches. + - Improvements, fixes, and new features are developed on the `next` branch or separate feature branches. 2. **Merging to `main`** - - Once changes are ready, merge them from `next` into the `main` branch. + - Once ready, changes are merged from the `next` branch into the `main` branch. 3. **Building the Release** - - After merging to `main`, initiate the build process for a new release. - - *Note:* Pushing to `main` does not automatically trigger a new version release. + - After merging to `main`, GitHub Actions automatically builds release images for all architectures and pushes them to the GitHub Container Registry with the version tag and the `latest` tag. 4. **Creating a GitHub Release** - - Create a new release on GitHub with the updated version details. + - A new GitHub release is manually created with details of the changes made in the version. 5. **Updating the CDN** - - Update the version information on the CDN: - [https://cdn.coollabs.io/coolify/versions.json](https://cdn.coollabs.io/coolify/versions.json) + - To make a new version publicly available, the version information on the CDN needs to be updated: [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 take hours or even days due to additional testing, stability checks, or potential hotfixes. +> The CDN update may not occur immediately after the GitHub release. It can take hours or even days due to additional testing, stability checks, or potential hotfixes. The update becomes available only after the CDN is updated. ## Version Types
- Stable + Stable (Coming Soon) -- **Stable (v4.0.0) (Coming Soon)** - - The production version suitable for stable, production environments. - - **Update Frequency:** Every 2 to 4 weeks, with possible hotfixes. - - **Release Size:** Larger but less frequent releases. Multiple nightly versions consolidate into a single stable release. +- **Stable (v4.0.0)** + - The production version suitable for stable, production environments (generally recommended). + - **Update Frequency:** Every 2 to 4 weeks, with more frequent possible hotfixes. + - **Release Size:** Larger but less frequent releases. Multiple nightly versions are consolidated into a single stable release. - **Versioning Scheme:** Follows semantic versioning (e.g., `v4.0.0`). - **Installation Command:** ```bash @@ -56,9 +54,10 @@ This guide outlines the release process for Coolify, intended for developers and Nightly - **Nightly** - - Features frequent updates, potentially weekly or even daily. - - **Update Frequency:** Very high; ideal for testing the latest changes. - - **Versioning Scheme:** [To be added] + - The latest development version, suitable for testing the latest changes and experimenting with new features. + - **Update Frequency:** Daily or bi-weekly updates. + - **Release Size:** Smaller, more frequent releases. + - **Versioning Scheme:** TO BE DETERMINED - **Installation Command:** ```bash curl -fsSL https://cdn.coollabs.io/coolify-nightly/install.sh | bash -s next @@ -73,9 +72,11 @@ This guide outlines the release process for Coolify, intended for developers and Beta - **Beta** - - Test releases for the upcoming stable version or new features. - - **Purpose:** Allows users to test and provide feedback on new features before they become stable. - - **Versioning Scheme:** [To be added] + - Test releases for the upcoming stable version. + - **Purpose:** Allows users to test and provide feedback on new features and changes before they become stable. + - **Update Frequency:** Available if we think beta testing is necessary. + - **Release Size:** Same size as stable release as it will become the next stabe release after some time. + - **Versioning Scheme:** Follows semantic versioning (e.g., `4.0.0-beta.341`). - **Installation Command:** ```bash curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash @@ -85,34 +86,34 @@ This guide outlines the release process for Coolify, intended for developers and ## Version Availability -When a new version is released and a new GitHub release is created, it does not immediately become available for your instance. Below is information on version availability for different instance types. +When a new version is released and a new GitHub release is created, it doesn't immediately become available for your instance. Here's how version availability works for different instance types. ### Self-Hosted -- **Update Frequency:** Faster and more frequent updates, especially on the nightly release channel. +- **Update Frequency:** More frequent updates, especially on the nightly release channel. - **Update Methods:** 1. **Manual Update in Instance Settings:** - - Navigate to `Settings > Update Check Frequency` and click the "Check Manually" button. - - An upgrade button will appear on the sidebar page if an update is available. + - Go to `Settings > Update Check Frequency` and click the `Check Manually` button. + - If an update is available, an upgrade button will appear on the sidebar. 2. **Automatic Update:** - - If auto-update is enabled, the instance will update automatically. + - If enabled, the instance will update automatically at the time set in the settings. 3. **Re-run Installation Script:** - - Execute the installation script to automatically upgrade to the latest version available on the CDN. + - Run the installation script again to upgrade to the latest version available on the CDN: ```bash curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash ``` > [!IMPORTANT] -> If a new release is available on GitHub but your instance hasn't updated, the CDN might not have been updated yet. This delay ensures stability and allows for hotfixes before official release. +> If a new release is available on GitHub but your instance hasn't updated or no upgrade button is shown, the CDN might not have been updated yet. This intentional delay ensures stability and allows for hotfixes before official release. ### Cloud -- **Update Frequency:** Less frequent, focusing on stability with manually tested versions. -- **Update Process:** - - Updates are managed by @andrasbacsai, who ensures that each cloud version is thoroughly tested and stable before release. +- **Update Frequency:** Less frequent as it's a managed service. The cloud version may be several versions behind the self-hosted version. +- **Update Method:** + - Updates are managed by @andrasbacsai, who ensures each cloud version is thoroughly tested and stable before release. > [!IMPORTANT] -> If a new GitHub release exists but the cloud version hasn't been updated, it's because @andrasbacsai hasn't released it yet. This ensures the cloud version remains stable. You'll need to wait for the update. +> If new GitHub release(s) exist but the cloud version is still behind, it's because @andrasbacsai hasn't updated it yet to ensure stability. You'll need to wait for him to do the update. ## Manually Update to Specific Versions @@ -124,4 +125,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`). +Replace `` with the version you want to update to (for example `4.0.0-beta.332`). From d1f28b42e51103d5b37ee143d7b24a2420b7744a Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Wed, 18 Sep 2024 18:21:08 +0200 Subject: [PATCH 07/10] Update RELEASE.md --- RELEASE.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 2dd51db48..91d96d12d 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -31,14 +31,14 @@ This guide outlines the release process for Coolify, intended for developers and - To make a new version publicly available, the version information on the CDN needs to be updated: [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 take hours or even days due to additional testing, stability checks, or potential hotfixes. The update becomes available only after the CDN is updated. +> The CDN update may not occur immediately after the GitHub release. It can take hours or even days due to additional testing, stability checks, or potential hotfixes. **The update becomes available only after the CDN is updated.** ## Version Types
- Stable (Coming Soon) + Stable (coming soon) -- **Stable (v4.0.0)** +- **Stable** - The production version suitable for stable, production environments (generally recommended). - **Update Frequency:** Every 2 to 4 weeks, with more frequent possible hotfixes. - **Release Size:** Larger but less frequent releases. Multiple nightly versions are consolidated into a single stable release. @@ -63,25 +63,28 @@ This guide outlines the release process for Coolify, intended for developers and curl -fsSL https://cdn.coollabs.io/coolify-nightly/install.sh | bash -s next ``` -> [!WARNING] -> Do not use nightly builds in production as there is no guarantee of stability. + > [!WARNING] + > Do not use nightly builds in production as there is no guarantee of stability.
- Beta + Beta (Coming Soon) -- **Beta** +- **Beta (coming soon)** - Test releases for the upcoming stable version. - **Purpose:** Allows users to test and provide feedback on new features and changes before they become stable. - **Update Frequency:** Available if we think beta testing is necessary. - **Release Size:** Same size as stable release as it will become the next stabe release after some time. - - **Versioning Scheme:** Follows semantic versioning (e.g., `4.0.0-beta.341`). + - **Versioning Scheme:** Follows semantic versioning (e.g., `4.1.0-beta.2`). - **Installation Command:** ```bash curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash ``` + > [!WARNING] + > Do not use beta builds in production as there is no guarantee of stability. +
## Version Availability @@ -91,6 +94,7 @@ When a new version is released and a new GitHub release is created, it doesn't i ### Self-Hosted - **Update Frequency:** More frequent updates, especially on the nightly release channel. +- **Update Availability:** New versions are available once the CDN has been updated. - **Update Methods:** 1. **Manual Update in Instance Settings:** - Go to `Settings > Update Check Frequency` and click the `Check Manually` button. @@ -104,16 +108,17 @@ When a new version is released and a new GitHub release is created, it doesn't i ``` > [!IMPORTANT] -> If a new release is available on GitHub but your instance hasn't updated or no upgrade button is shown, the CDN might not have been updated yet. This intentional delay ensures stability and allows for hotfixes before official release. +> If a new release is available on GitHub but your instance hasn't updated yetor no upgrade button is shown, the CDN might not have been updated yet. This intentional delay ensures stability and allows for hotfixes before official release. ### Cloud -- **Update Frequency:** Less frequent as it's a managed service. The cloud version may be several versions behind the self-hosted version. +- **Update Frequency:** Less frequent as it's a managed service. +- **Update Availability:** New versions are available once @andrasbacsai has updated the cloud version manually. - **Update Method:** - - Updates are managed by @andrasbacsai, who ensures each cloud version is thoroughly tested and stable before release. + - Updates are managed by @andrasbacsai, who ensures each cloud version is thoroughly tested and stable before releasing it. > [!IMPORTANT] -> If new GitHub release(s) exist but the cloud version is still behind, it's because @andrasbacsai hasn't updated it yet to ensure stability. You'll need to wait for him to do the update. +> The cloud version of Coolify may be several versions behind the latest GitHub releases. This is intentional to ensure stability and reliability for cloud users. ## Manually Update to Specific Versions From 5b27eef984be6edb4cfbd01473d715ca4380712c Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Wed, 18 Sep 2024 18:28:21 +0200 Subject: [PATCH 08/10] Update RELEASE.md --- RELEASE.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 91d96d12d..2bf5d7b29 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -63,8 +63,8 @@ This guide outlines the release process for Coolify, intended for developers and curl -fsSL https://cdn.coollabs.io/coolify-nightly/install.sh | bash -s next ``` - > [!WARNING] - > Do not use nightly builds in production as there is no guarantee of stability. +> [!WARNING] +> Do not use nightly builds in production as there is no guarantee of stability.
@@ -82,8 +82,8 @@ This guide outlines the release process for Coolify, intended for developers and curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash ``` - > [!WARNING] - > Do not use beta builds in production as there is no guarantee of stability. +> [!WARNING] +> Do not use beta builds in production as there is no guarantee of stability.
@@ -113,12 +113,12 @@ When a new version is released and a new GitHub release is created, it doesn't i ### Cloud - **Update Frequency:** Less frequent as it's a managed service. -- **Update Availability:** New versions are available once @andrasbacsai has updated the cloud version manually. +- **Update Availability:** New versions are available once Andras has updated the cloud version manually. - **Update Method:** - - Updates are managed by @andrasbacsai, who ensures each cloud version is thoroughly tested and stable before releasing it. + - Updates are managed by Andras, who ensures each cloud version is thoroughly tested and stable before releasing it. > [!IMPORTANT] -> The cloud version of Coolify may be several versions behind the latest GitHub releases. This is intentional to ensure stability and reliability for cloud users. +> The cloud version of Coolify may be several versions behind the latest GitHub releases even if the CDN is updated. This is intentional to ensure stability and reliability for cloud users and Andras will manully update the cloud version when the update is ready. ## Manually Update to Specific Versions From 4e8708051d8c123364478bcb874c27c4c5ee1bda Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Wed, 18 Sep 2024 18:34:54 +0200 Subject: [PATCH 09/10] Update RELEASE.md --- RELEASE.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 2bf5d7b29..13d212e68 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -63,15 +63,12 @@ This guide outlines the release process for Coolify, intended for developers and curl -fsSL https://cdn.coollabs.io/coolify-nightly/install.sh | bash -s next ``` -> [!WARNING] -> Do not use nightly builds in production as there is no guarantee of stability. -
- Beta (Coming Soon) + Beta -- **Beta (coming soon)** +- **Beta** - Test releases for the upcoming stable version. - **Purpose:** Allows users to test and provide feedback on new features and changes before they become stable. - **Update Frequency:** Available if we think beta testing is necessary. @@ -82,11 +79,11 @@ This guide outlines the release process for Coolify, intended for developers and curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash ``` -> [!WARNING] -> Do not use beta builds in production as there is no guarantee of stability. -
+> [!WARNING] +> Do not use nightly/beta builds in production as there is no guarantee of stability. + ## Version Availability When a new version is released and a new GitHub release is created, it doesn't immediately become available for your instance. Here's how version availability works for different instance types. @@ -108,7 +105,7 @@ When a new version is released and a new GitHub release is created, it doesn't i ``` > [!IMPORTANT] -> If a new release is available on GitHub but your instance hasn't updated yetor no upgrade button is shown, the CDN might not have been updated yet. This intentional delay ensures stability and allows for hotfixes before official release. +> If a new release is available on GitHub but your instance hasn't updated yet or no upgrade button is shown in the UI, the CDN might not have been updated yet. This intentional delay ensures stability and allows for hotfixes before official release. ### Cloud From cb177dae58a516bec5b945bf8e7b2869164e3442 Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Wed, 18 Sep 2024 18:36:04 +0200 Subject: [PATCH 10/10] Update RELEASE.md --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 13d212e68..d9f05f17d 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -73,7 +73,7 @@ This guide outlines the release process for Coolify, intended for developers and - **Purpose:** Allows users to test and provide feedback on new features and changes before they become stable. - **Update Frequency:** Available if we think beta testing is necessary. - **Release Size:** Same size as stable release as it will become the next stabe release after some time. - - **Versioning Scheme:** Follows semantic versioning (e.g., `4.1.0-beta.2`). + - **Versioning Scheme:** Follows semantic versioning (e.g., `4.1.0-beta.1`). - **Installation Command:** ```bash curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash