ci: fix release workflow

Signed-off-by: Mathew Wicks <[email protected]>

Author: thesuperzapper

.github/workflows/release.yml

@@ -30,41 +30,39 @@ jobs:
             sha256sum "$file" > "$file.sha256"
           done
 
-      - name: Create GitHub Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create GitHub Release and Upload Release Assets
+        uses: actions/github-script@v6
         with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
-          draft: true
-          prerelease: ${{ contains(github.ref, "-') }}
+          script: |
+            const fs = require('fs');
+            const path = require('path');
+            
+            const { repo: { owner, repo }, ref: tag_ref } = context;
+            const tag_name = tag_ref.replace('refs/tags/', '');
+            
+            // Create a draft release
+            const response = await github.rest.repos.createRelease({
+              owner: owner,
+              repo: repo,
+              tag_name: tag_name,
+              name: `deployKF CLI ${tag_name}`,
+              draft: true,
+              prerelease: tag_name.includes('-'),
+            });
+            const { id: release_id } = response.data;
 
-      - name: Upload binaries and checksums
-        run: |
-          for file in ./bin/deploykf-*; do
-            asset_name="$(basename $file)"
-            asset_path="./bin/$asset_name"
-            asset_checksum_path="./bin/$asset_name.sha256"
-
-            echo "Uploading $asset_name"
-            curl \
-              --progress-bar \
-              --location \
-              --request POST \
-              --header "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
-              --header 'Content-Type: application/octet-stream' \
-              --upload-file "$asset_path" \
-              --url "${{ steps.create_release.outputs.upload_url }}?name=$asset_name"
-
-            echo "Uploading $asset_name.sha256"
-            curl \
-              --progress-bar \
-              --location \
-              --request POST \
-              --header "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
-              --header 'Content-Type: text/plain' \
-              --upload-file "$asset_checksum_path" \
-              --url "${{ steps.create_release.outputs.upload_url }}?name=$asset_name.sha256"
-          done
+            // Upload each binary and checksum file
+            const globber = await glob.create('./bin/deploykf-*');
+            for await (const file of globber.globGenerator()) {
+              const asset_name = path.basename(file);
+              const asset_path = `./bin/${asset_name}`;
+            
+              core.info(`Uploading ${asset_name}`);
+              await github.rest.repos.uploadReleaseAsset({
+                owner: owner,
+                repo: repo,
+                release_id: release_id,
+                name: asset_name,
+                data: fs.readFileSync(asset_path),
+              });
+            }

README.md

@@ -1,28 +1,49 @@
-# deployKF - cli
+# deployKF - Command Line Interface (CLI)
 
-The CLI for [deployKF](https://github.com/deployKF/deployKF).
+[![Check Commit](https://github.com/deployKF/cli/actions/workflows/check-commit.yml/badge.svg)](https://github.com/deployKF/cli/actions/workflows/check-commit.yml)
+
+This repo contains the command line interface (CLI) for [deployKF](https://github.com/deployKF/deployKF).
+
+## Install
+
+You can install the `deploykf` CLI by downloading the appropriate binary for your OS from the [releases page](https://github.com/deployKF/cli/releases).
+ - You may wish to rename the binary to `deploykf` (or `deploykf.exe` on Windows).
+ - On Unix-like systems, you may need to make the binary executable by running `chmod +x deploykf`.
 
 ## Usage
 
 The simplest usage of the `deploykf` CLI is to run the following command:
 
 ```bash
 deploykf \
-  --source-version=v0.1.0 \
-  --values "./custom-values.yaml" \
-  --output-dir "./GENERATOR_OUTPUT"
+  --source-version v0.1.0 \
+  --values ./custom-values.yaml \
+  --output-dir ./GENERATOR_OUTPUT
 ```
 
-Which will generate deployKF manifests in the `./GENERATOR_OUTPUT` directory based on the `v0.1.0` source version and your `./values.yaml` file.
-
-The `--source-version` flag must be a tag associated with a [deployKF release](https://github.com/deployKF/deployKF/releases).
+This command will generate deployKF manifests in the `./GENERATOR_OUTPUT` directory using the `v0.1.0` source version and the values specified in your `./custom-values.yaml` file. 
+Note that the `--source-version` flag must correspond to a tag from a [deployKF release](https://github.com/deployKF/deployKF/releases).
 
 ## Development
 
-Running `make build` will build the binary for your local platform and output it to `./bin/deploykf`.
+Here are some helpful commands when developing the CLI:
+
+- `make build`: Builds the binary for your local platform and outputs it to `./bin/deploykf`.
+- `make install`: Installs the binary to `/usr/local/bin`.
+- `make lint`: Runs `golangci-lint` against the codebase to check for errors.
+- `make lint-fix`: Attempts to automatically fix any linting errors found.
 
-Running `make install` will install the binary to `/usr/local/bin`.
+## Releasing
 
-Running `make lint` will run `golangci-lint` against the codebase.
+To release a new version of the CLI, follow these steps:
 
-Running `make lint-fix` will attempt to automatically fix linting errors.
+1. For a new minor or major release, create a `release-*` branch first.
+    - For example, for the `v0.2.0` release, create a new branch called `release-0.2`. 
+    - This allows for the continued release of bug fixes to older CLI versions.
+2. Create a new tag on the appropriate release branch for the version you are releasing.
+    - For instance, you might create `v0.1.1` or `v0.1.1-alpha.1` on the `release-0.1` branch.
+    - Remember to create tags only on the `release-*` branches, not on the `main` branch.
+3. When a new semver tag is created, a workflow will automatically create a GitHub draft release.
+    - The release will include binaries and corresponding SHA256 checksums for all supported platforms.
+    - Don't forget to add the changelog to release notes.
+4. Manually publish the draft release.