From 7232d44a76f63b03c9d4f44de15fa3910ba49309 Mon Sep 17 00:00:00 2001 From: Brett <27568879+BrettCleary@users.noreply.github.com> Date: Thu, 14 Mar 2024 21:12:37 -0700 Subject: [PATCH 1/7] log the zip path instead of file path --- src/releases.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/releases.ts b/src/releases.ts index 8e19cbe..32fc42d 100644 --- a/src/releases.ts +++ b/src/releases.ts @@ -16,7 +16,7 @@ export async function uploadRelease(valist: Client, config: ReleaseConfig, yamlC return [platform, filePath] } const zipPath = getZipName(filePath); - CliUx.ux.action.start(`zipping ${filePath}`); + CliUx.ux.action.start(`zipping ${zipPath}`); await zipDirectory(filePath, zipPath); CliUx.ux.action.stop(); return [platform, zipPath] as [string, string]; From 6cbf0fb97ebb3e69225bf643ca53d157a22f0dcb Mon Sep 17 00:00:00 2001 From: Brett <27568879+BrettCleary@users.noreply.github.com> Date: Thu, 14 Mar 2024 21:12:48 -0700 Subject: [PATCH 2/7] lower case the project and account names --- src/commands/publish.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/commands/publish.ts b/src/commands/publish.ts index 0d32b64..c7b4147 100644 --- a/src/commands/publish.ts +++ b/src/commands/publish.ts @@ -74,6 +74,9 @@ export default class Publish extends Command { if (!config.release) this.error('invalid release name'); if (!config.platforms) this.error('no platforms configured'); + config.account = config.account.toLowerCase(); + config.project = config.project.toLowerCase(); + return {config, yamlConfig} } From 13b50e17e7b99580730e46e1e21728409244842f Mon Sep 17 00:00:00 2001 From: Brett <27568879+BrettCleary@users.noreply.github.com> Date: Thu, 14 Mar 2024 21:22:26 -0700 Subject: [PATCH 3/7] update readme --- README.md | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 09106c6..b3523c7 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ HyperPlay command line interface. * [Flags & Environment Variables](#flags_and_env) * [YML](#yml) * [Commands](#commands) +* [FAQ](#faq) # Install @@ -61,16 +62,28 @@ HYPERPLAY_TARGET_CHANNEL=beta ## YML Create a `hyperplay.yml` in your project folder. +`zip` is true if you want to zip the folder or file prior to upload. +- Note that for HyperPlay submissions, you will need `zip: true` unless you are uploading a zip file. + ```yml account: test-ground project: test44 release: 0.0.7 platforms: - darwin_amd64: dist/darwin/amd64/hello-go - darwin_arm64: dist/darwin/arm64/hello-go - linux_amd64: dist/linux/amd64/hello-go - windows_amd64: dist/windows/amd64/hello-go + darwin_amd64: + path: dist/darwin/amd64/hello-go + zip: true + darwin_arm64: + path: dist/darwin/arm64/hello-go + zip: true + linux_amd64: + path: dist/linux/amd64/hello-go + zip: true +# dist/windows/amd64/hello-go.zip zipped in a separate step so we don't need to zip with the cli + windows_amd64: + path: dist/windows/amd64/hello-go.zip + zip: false ``` @@ -168,4 +181,14 @@ EXAMPLES $ hyperplay publish ipfs/go-ipfs/v0.12.3 dist/ ``` - \ No newline at end of file + + +# FAQ + +### How do I fix this error? "user is not an account or project member" + +Make sure you pass the private key of your Release Manager with the flag `--private-key=` + +For HyperPlay Projects, make sure the public key is added as a Release Manager on your HyperPlay project. You can modify the project members at https://developers.hyperplay.xyz///settings. + +It is also possible to add the public key directly to your project through the [Valist registry](https://polygonscan.com/address/0xd504d012d78b81fa27288628f3fc89b0e2f56e24) by calling `addProjectMember`. From 6cdce51bd631a0b92f6d8c336796ce7131bc4b6c Mon Sep 17 00:00:00 2001 From: Brett <27568879+BrettCleary@users.noreply.github.com> Date: Thu, 14 Mar 2024 21:39:23 -0700 Subject: [PATCH 4/7] Update README.md --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b3523c7..8cbffd7 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ HyperPlay command line interface. * [HyperPlay CLI](#hyperplay-cli) * [Install](#install) * [Usage](#usage) - * [Flags & Environment Variables](#flags_and_env) + * [Flags and Environment Variables](#flags-and-environment-variables) * [YML](#yml) * [Commands](#commands) * [FAQ](#faq) @@ -37,7 +37,7 @@ USAGE ... ``` -## Flags & Environment Variables +## Flags and Environment Variables ```bash $ hyperplay publish [ACCOUNT] [PROJECT] [RELEASE] [--meta-tx] [--network ] [--private-key ] [--web ] [--darwin_amd64 ] [--darwin_arm64 ] [--windows_amd64 ] [--skip_hyperplay_publish] [--channel ] @@ -185,10 +185,20 @@ EXAMPLES # FAQ -### How do I fix this error? "user is not an account or project member" +## How do I fix "user is not an account or project member"? Make sure you pass the private key of your Release Manager with the flag `--private-key=` For HyperPlay Projects, make sure the public key is added as a Release Manager on your HyperPlay project. You can modify the project members at https://developers.hyperplay.xyz///settings. It is also possible to add the public key directly to your project through the [Valist registry](https://polygonscan.com/address/0xd504d012d78b81fa27288628f3fc89b0e2f56e24) by calling `addProjectMember`. + +## How do I find my account or project name? + +To get the account name, navigate to the [HyperPlay Dev Portal](https://developers.hyperplay.xyz) and on the project card, you can find your account name in the "Published by: Date: Thu, 14 Mar 2024 21:44:19 -0700 Subject: [PATCH 5/7] improve publish usage description --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8cbffd7..c9fa802 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,9 @@ HyperPlay command line interface. * [HyperPlay CLI](#hyperplay-cli) * [Install](#install) * [Usage](#usage) - * [Flags and Environment Variables](#flags-and-environment-variables) - * [YML](#yml) + * [Publish](#publish) + * [Flags and Environment Variables](#flags-and-environment-variables) + * [YML](#yml) * [Commands](#commands) * [FAQ](#faq) @@ -37,7 +38,11 @@ USAGE ... ``` -## Flags and Environment Variables +## Publish + +The `publish` command args and flags can be passed as CLI args or with a YML file. + +### Flags and Environment Variables ```bash $ hyperplay publish [ACCOUNT] [PROJECT] [RELEASE] [--meta-tx] [--network ] [--private-key ] [--web ] [--darwin_amd64 ] [--darwin_arm64 ] [--windows_amd64 ] [--skip_hyperplay_publish] [--channel ] @@ -59,7 +64,7 @@ HYPERPLAY_SKIP_HYPERPLAY_PUBLISH=false HYPERPLAY_TARGET_CHANNEL=beta ``` -## YML +### YML Create a `hyperplay.yml` in your project folder. `zip` is true if you want to zip the folder or file prior to upload. From 852ef022a4fd5c8dccf9df9d63026eb57527caab Mon Sep 17 00:00:00 2001 From: Brett <27568879+BrettCleary@users.noreply.github.com> Date: Thu, 14 Mar 2024 21:50:50 -0700 Subject: [PATCH 6/7] add note to use private key for publish --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c9fa802..55c09dd 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ USAGE The `publish` command args and flags can be passed as CLI args or with a YML file. +Note that in either case, you must pass a private key for an address added to your project or account with the cli flag `--private-key `. + ### Flags and Environment Variables ```bash $ hyperplay publish [ACCOUNT] [PROJECT] [RELEASE] [--meta-tx] [--network ] [--private-key ] [--web ] From 90f86b8d04d69a101813dc32c676296ab88f3a58 Mon Sep 17 00:00:00 2001 From: Brett <27568879+BrettCleary@users.noreply.github.com> Date: Thu, 14 Mar 2024 21:52:36 -0700 Subject: [PATCH 7/7] bump 2.10.2 --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 0ead65e..e87524d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@hyperplay/cli", - "version": "2.10.1", + "version": "2.10.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@hyperplay/cli", - "version": "2.10.1", + "version": "2.10.2", "license": "MPL-2.0", "dependencies": { "@oclif/core": "^1.8.0", diff --git a/package.json b/package.json index 83b5646..e0fe171 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@hyperplay/cli", - "version": "2.10.1", + "version": "2.10.2", "description": "Hyperplay CLI", "author": "HyperPlay Labs, Inc.", "bin": {