docs: add upgrade instructions for CE v1.1.0 (#183)

TomFern · web-flow · commit 670584329038 · 2025-03-28T15:08:10.000Z
## 📝 Description Update installation instructions to use v1.1.0 Add upgrade instructions to go from v1.0.1 to v1.1.0 See #139 ## ✅ Checklist - [X] I have tested this change - [ ] This change requires documentation update
diff --git a/docs/docs-contributing/VERSIONING.md b/docs/docs-contributing/VERSIONING.md
@@ -23,10 +23,20 @@ The latest version ID is always "CE" (without the semver). Older versions have t
 
 For example:
 
-- Latest version: "CE"
+- Latest version: "CE" (could be v2.0 or greater)
 - Version 1.0: "CE-1.0"
 - Version 1.1: "CE-1.1"
 
+When a new version is released, update the version number on `docusaurus.config.js`
+
+```js
+    "CE": {
+      label: 'Community Edition (1.1)',
+      path: 'CE',
+      banner: "none"
+    }
+```
+
 ### Enterprise Edition
 
 The latest version ID is always "EE" (without the semver). Older versions have the semver appended.
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -65,7 +65,7 @@ const config = {
               banner: "none",
             },
             "CE": {
-              label: 'Community Edition (1.0)',
+              label: 'Community Edition (1.1)',
               path: 'CE',
               banner: "none"
             }
@@ -184,7 +184,7 @@ const config = {
       // This is an optional announcement bar. It goes on the top of the page
       announcementBar: {
         id: `announcementBar-1`,
-        content: `⭐️ If you like Semaphore, <b>give it a star</b> on <a target="_blank" rel="noopener noreferrer" href="https://github.com/semaphoreio/semaphore">GitHub</a> and follow us on <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/semaphoreci">X (Twitter)</a>`,
+        content: `Semaphore CE <strong>v1.1.0 is out</strong> — ⭐️ If you like Semaphore, <em>give it a star</em> on <a target="_blank" rel="noopener noreferrer" href="https://github.com/semaphoreio/semaphore">GitHub</a>`,
         backgroundColor: '#49a26e',
         textColor: '#f5f6f7'
       },
diff --git a/docs/versioned_docs/version-CE/getting-started/install-aws-ec2.md b/docs/versioned_docs/version-CE/getting-started/install-aws-ec2.md
@@ -329,8 +329,9 @@ kubectl wait --timeout=90s --for=condition=available deployment emissary-apiext
 Finally, install the Semaphore with Helm:
 
 ```shell
-helm upgrade --install --debug semaphore oci://ghcr.io/semaphoreio/semaphore \
-  --version v1.0.1 \
+helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+  --debug \
+  --version v1.1.0 \
   --timeout 20m \
   --set global.domain.ip=${IP_ADDRESS} \
   --set global.domain.name=${DOMAIN} \
@@ -397,6 +398,31 @@ Once your have Semaphore up and running, check out the following pages to finish
 - [Invite users](../using-semaphore/organizations#people): invite users to your instance so they can start working on projects
 - [Add self-hosted agents](../using-semaphore/self-hosted): add more machines to scale up the capacity of your CI/CD platform
 
+## How to Upgrade Semaphore {#upgrade}
+
+To upgrade Semaphore from version `v1.0.x`, follow these steps:
+
+<Steps>
+
+1. Connect to your server running Semaphore (see [Step 7](#env))
+2. Check that you can access the Kubernetes cluster (k3s):
+
+    ```shell
+    export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+    kubectl get nodes
+    ```
+
+3. Run the following command to upgrade to `v1.1.0`
+
+    ```shell
+    helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+      --debug \
+      --version v1.1.0 \
+      --reuse-values
+    ```
+
+</Steps>
+
 ## How to Uninstall Semaphore from AWS EC2
 
 If you want to completely uninstall Semaphore, follow these steps.
diff --git a/docs/versioned_docs/version-CE/getting-started/install-eks.md b/docs/versioned_docs/version-CE/getting-started/install-eks.md
@@ -146,8 +146,9 @@ echo "CERT_NAME=${CERT_NAME}"
 Install Semaphore with Helm:
 
 ```shell
-helm upgrade --install --debug semaphore oci://ghcr.io/semaphoreio/semaphore \
-  --version v1.0.1 \
+helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+  --debug \
+  --version v1.1.0 \
   --timeout 20m \
   --set global.domain.name="${DOMAIN}" \
   --set ingress.ssl.certName="${CERT_NAME}" \
@@ -211,6 +212,30 @@ Once your have Semaphore up and running, check out the following pages to finish
 - [Guided tour](./guided-tour): complete the guided tour to get familiarized with Semaphore Community Edition
 - [Add self-hosted agents](../using-semaphore/self-hosted): add more machines to scale up the capacity of your CI/CD platform
 
+## How to Upgrade Semaphore {#upgrade}
+
+To upgrade Semaphore from version `v1.0.x`, follow these steps:
+
+<Steps>
+
+1. Connect to your AWS EKS cluster (see [Step 5](#crds))
+2. Check that you can access the Kubernetes cluster:
+
+    ```shell
+    kubectl get nodes
+    ```
+
+3. Run the following command to upgrade to `v1.1.0`
+
+    ```shell
+    helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+      --debug \
+      --version v1.1.0 \
+      --reuse-values
+    ```
+
+</Steps>
+
 ## How to Uninstall Semaphore from EKS
 
 If you want to completely uninstall Semaphore, follow these steps.
diff --git a/docs/versioned_docs/version-CE/getting-started/install-gcompute.md b/docs/versioned_docs/version-CE/getting-started/install-gcompute.md
@@ -321,8 +321,9 @@ kubectl wait --timeout=90s --for=condition=available deployment emissary-apiext
 Finally, install Semaphore with Helm:
 
 ```shell title="remote shell - install Semaphore"
-helm upgrade --install --debug semaphore oci://ghcr.io/semaphoreio/semaphore \
-  --version v1.0.1 \
+helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+  --debug \
+  --version v1.1.0 \
   --timeout 20m \
   --set global.domain.ip=${IP_ADDRESS} \
   --set global.domain.name=${DOMAIN} \
@@ -390,6 +391,30 @@ Once you have Semaphore up and running, check out the following pages to finish
 - [Invite users](../using-semaphore/organizations#people): invite users to your instance so they can start working on projects
 - [Add self-hosted agents](../using-semaphore/self-hosted): add more machines to scale up the capacity of your CI/CD platform
 
+## How to Upgrade Semaphore {#upgrade}
+
+To upgrade Semaphore from version `v1.0.x`, follow these steps:
+
+<Steps>
+
+1. Connect to your server running Semaphore (see [Step 8](#env))
+2. Check that you can access the Kubernetes cluster (k3s):
+
+    ```shell
+    export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+    kubectl get nodes
+    ```
+
+3. Run the following command to upgrade to `v1.1.0`
+
+    ```shell
+    helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+      --version v1.1.0 \
+      --reuse-values
+    ```
+
+</Steps>
+
 ## How to Uninstall Semaphore from Google Compute
 
 If you want to completely uninstall Semaphore, follow these steps.
diff --git a/docs/versioned_docs/version-CE/getting-started/install-gke.md b/docs/versioned_docs/version-CE/getting-started/install-gke.md
@@ -278,8 +278,9 @@ ls certs/live/${DOMAIN}/privkey.pem certs/live/${DOMAIN}/fullchain.pem
 Run the following to install Semaphore:
 
 ```shell title="Install Semaphore"
-helm upgrade --install --debug semaphore oci://ghcr.io/semaphoreio/semaphore \
-  --version v1.0.1 \
+helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+  --debug \
+  --version v1.1.0 \
   --timeout 20m \
   --set global.domain.ip=${IP_ADDRESS} \
   --set global.domain.name="${DOMAIN}" \
@@ -371,6 +372,30 @@ Once your have Semaphore up and running, check out the following pages to finish
 - [Guided tour](./guided-tour): complete the guided tour to get familiarized with Semaphore Community Edition
 - [Add self-hosted agents](../using-semaphore/self-hosted): add more machines to scale up the capacity of your CI/CD platform
 
+## How to Upgrade Semaphore {#upgrade}
+
+To upgrade Semaphore from version `v1.0.x`, follow these steps:
+
+<Steps>
+
+1. Connect to your Google project (see [Step 2](#setup))
+2. Check that you can access the Kubernetes cluster:
+
+    ```shell
+    kubectl get nodes
+    ```
+
+3. Run the following command to upgrade to `v1.1.0`
+
+    ```shell
+    helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+      --debug \
+      --version v1.1.0 \
+      --reuse-values
+    ```
+
+</Steps>
+
 ## How to Uninstall Semaphore from GKE
 
 If you want to completely uninstall Semaphore, follow these steps.
diff --git a/docs/versioned_docs/version-CE/getting-started/install-ubuntu.md b/docs/versioned_docs/version-CE/getting-started/install-ubuntu.md
@@ -196,8 +196,9 @@ kubectl wait --timeout=90s --for=condition=available deployment emissary-apiext
 Finally, install Semaphore with Helm:
 
 ```shell title="remote shell - install Semaphore"
-helm upgrade --install --debug semaphore oci://ghcr.io/semaphoreio/semaphore \
-  --version v1.0.1 \
+helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+  --debug \
+  --version v1.1.0 \
   --timeout 20m \
   --set global.domain.ip=${IP_ADDRESS} \
   --set global.domain.name=${DOMAIN} \
@@ -265,6 +266,33 @@ Once you have Semaphore up and running, check out the following pages to finish
 - [Invite users](../using-semaphore/organizations#people): invite users to your instance so they can start working on projects
 - [Add self-hosted agents](../using-semaphore/self-hosted): add more machines to scale up the capacity of your CI/CD platform
 
+
+## How to Upgrade Semaphore {#upgrade}
+
+To upgrade Semaphore from version `v1.0.x`, follow these steps:
+
+<Steps>
+
+1. Connect to your server running Semaphore via SSH
+2. Check that you can access the Kubernetes cluster (k3s):
+
+    ```shell
+    export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
+    kubectl get nodes
+    ```
+
+3. Run the following command to upgrade to `v1.1.0`
+
+    ```shell
+    helm upgrade --install semaphore oci://ghcr.io/semaphoreio/semaphore \
+      --debug \
+      --version v1.1.0 \
+      --reuse-values
+    ```
+
+</Steps>
+
+
 ## How to Uninstall Semaphore
 
 If you want to completely uninstall Semaphore, follow these steps.
