Support release-notes in create-release action

replicatedhq · Jan 10, 2025 · 2ae7c79 · 2ae7c79
1 parent b78431f
commit 2ae7c79
Show file tree

Hide file tree

Showing 47 changed files with 92,919 additions and 27,862 deletions.
diff --git a/.github/workflows/test-create-release.yml b/.github/workflows/test-create-release.yml
@@ -41,6 +41,8 @@ jobs:
           api-token: ${{ secrets.REPLICATED_API_TOKEN }}
           app-slug: replicated-actions-ci # from the Replicated QA team
           chart: wordpress-${{ env.WORDPRESS_CHART_VERSION }}.tgz
+          promote-channel: test-channel
+          release-notes: release notes for 1.0.0-helm
 
       - name: test create-release / kots-install
         id: create-release-kots-install
@@ -49,3 +51,6 @@ jobs:
           api-token: ${{ secrets.REPLICATED_API_TOKEN }}
           app-slug: replicated-actions-ci # from the Replicated QA team
           yaml-dir: ./test/kots-install/yaml
+          promote-channel: test-channel
+          version: 1.0.0-kots
+          release-notes: release notes for 1.0.0-kots
diff --git a/archive-channel/dist/index.js b/archive-channel/dist/index.js
diff --git a/archive-channel/dist/index.js.map b/archive-channel/dist/index.js.map
diff --git a/archive-customer/dist/index.js b/archive-customer/dist/index.js
diff --git a/archive-customer/dist/index.js.map b/archive-customer/dist/index.js.map
diff --git a/create-cluster/dist/index.js b/create-cluster/dist/index.js
diff --git a/create-cluster/dist/index.js.map b/create-cluster/dist/index.js.map
diff --git a/create-customer/dist/index.js b/create-customer/dist/index.js
diff --git a/create-customer/dist/index.js.map b/create-customer/dist/index.js.map
diff --git a/create-object-store/dist/index.js b/create-object-store/dist/index.js
diff --git a/create-object-store/dist/index.js.map b/create-object-store/dist/index.js.map
diff --git a/create-release/README.md b/create-release/README.md
@@ -12,6 +12,7 @@ chart["chart"]
 yaml_dir["yaml-dir"]
 promote_channel["promote-channel"]
 version["version"]
+release_notes["release-notes"]
 channel_slug["channel-slug"]
 release_sequence["release-sequence"]
 app_slug ---> replicated_create_release
@@ -20,6 +21,7 @@ chart ---> replicated_create_release
 yaml_dir ---> replicated_create_release
 promote_channel ---> replicated_create_release
 version ---> replicated_create_release
+release_notes ---> replicated_create_release
 replicated_create_release ---> channel_slug
 replicated_create_release ---> release_sequence
 ```
@@ -30,8 +32,9 @@ replicated_create_release ---> release_sequence
 | api-token |  | True | API Token. |
 | chart |  | False | Path to the helm chart (One of `chart` or `yaml-dir` is required). |
 | yaml-dir |  | False | The directory containing multiple yamls for a Replicated release (One of `chart` or `yaml-dir` is required). |
-| promote-channel |  | False | Channel name or id to promote this release to. |
-| version |  | False | Release version |
+| promote-channel |  | False | Channel name or id to promote this release to. If not specified, the release will not be promoted. |
+| version |  | False | Release version. This will be ignored if `promote-channel` is not specified. |
+| release-notes |  | False | Release notes. This will be ignored if `promote-channel` is not specified. |
 
 ## Outputs
 | Name | Description |

diff --git a/create-release/action.yml b/create-release/action.yml
@@ -14,10 +14,13 @@ inputs:
     description: "The directory containing multiple yamls for a Replicated release (One of `chart` or `yaml-dir` is required)."
     required: false
   promote-channel:
-    description: "Channel name or id to promote this release to."
+    description: "Channel name or id to promote this release to. If not specified, the release will not be promoted."
     required: false
   version:
-    description: "Release version"
+    description: "Release version. This will be ignored if `promote-channel` is not specified."
+    required: false
+  release-notes:
+    description: "Release notes. This will be ignored if `promote-channel` is not specified."
     required: false
 outputs:
   channel-slug: # slug of the channel