Merge branch 'main' into derek/package-init-doc-touchup

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.84.10](https://github.com/kurtosis-tech/kurtosis/compare/0.84.9...0.84.10) (2023-10-23)
+
+
+### Bug Fixes
+
+* bug in portal forwarding via run ([#1598](https://github.com/kurtosis-tech/kurtosis/issues/1598)) ([bf534c3](https://github.com/kurtosis-tech/kurtosis/commit/bf534c35055f4ec3e19cc1f1e2e32e8d29e61b5a))
+
 ## [0.84.9](https://github.com/kurtosis-tech/kurtosis/compare/0.84.8...0.84.9) (2023-10-19)
 
 

LICENSE.md

@@ -3,7 +3,7 @@ Business Source License 1.1
 Parameters
 
 Licensor:             Kurtosis Technologies, Inc.
-Licensed Work:        Kurtosis 0.84.9
+Licensed Work:        Kurtosis 0.84.10
 The Licensed Work is (c) 2023 Kurtosis Technologies, Inc.
 Additional Use Grant: You may make use of the Licensed Work, provided that
 you may not use the Licensed Work for an Environment Orchestration Service.
@@ -12,7 +12,7 @@ you may not use the Licensed Work for an Environment Orchestration Service.
                       allows third parties (other than your employees and
                       contractors) to create distributed system environments.
 
-Change Date:          2027-10-19
+Change Date:          2027-10-23
 
 Change License:       AGPLv3 (GNU Affero General Public License Version 3)
 

README.md

@@ -141,15 +141,15 @@ echo "${BREW_PREFIX}/bin/bash" | sudo tee -a /etc/shells
 # Optional: make bash your default shell
 chsh -s "${BREW_PREFIX}/bin/bash"
 ```
-  
+
 #### Git
 
 On MacOS:
 ```bash
 # Install modern version of git, the one that ships on MacOS can be too old
 brew install git
 ```
- 
+
 #### Docker
 
 On MacOS:
@@ -168,13 +168,28 @@ PATH="${BREW_PREFIX}/opt/[email protected]/bin:$PATH"
 PATH="${HOME}/go/bin:$PATH"
 ```
 
+On Ubuntu:
+```bash
+wget https://go.dev/dl/go1.19.13.linux-amd64.tar.gz
+tar -C /usr/local -zxf go1.19.13.linux-amd64.tar.gz
+# Add the following to your bashrc or equivalent.
+export PATH=$PATH:/usr/local/go/bin
+```
+
 #### Goreleaser
 
 On MacOS:
 ```bash
 brew install goreleaser/tap/goreleaser
 ```
 
+On Ubuntu:
+```bash
+echo 'deb [trusted=yes] https://repo.goreleaser.com/apt/ /' | sudo tee /etc/apt/sources.list.d/goreleaser.list
+sudo apt update
+sudo apt install goreleaser
+```
+
 #### Node (16.14 or above) and Yarn
 
 On MacOS, using `NVM`:
@@ -185,9 +200,17 @@ nvm install 16.14.0
 npm install -g yarn
 ```
 
+On Ubuntu, using `NVM`:
+```bash
+curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
+source ~/.bashrc
+nvm install 16.14.0
+npm install -g yarn
+```
+
 #### Rust
 
-On MacOS:
+On MacOS, Ubuntu:
 ```bash
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 ```
@@ -199,8 +222,17 @@ On MacOS:
 brew install protoc-gen-go
 brew install protoc-gen-go-grpc
 go install connectrpc.com/connect/cmd/protoc-gen-connect-go@latest
-npm install -g ts-protoc-gen
-npm install -g grpc-tools
+yarn global add ts-protoc-gen
+yarn global add grpc-tools
+```
+
+On Ubuntu:
+```bash
+go install google.golang.org/grpc/cmd/protoc-gen-go@latest
+go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
+go install connectrpc.com/connect/cmd/protoc-gen-connect-go@latest
+yarn global add ts-protoc-gen
+yarn global add grpc-tools
 ```
 
 Build Instructions

api/golang/kurtosis_version/kurtosis_version.go

@@ -9,6 +9,6 @@ const (
 	// !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!!
 	// This is necessary so that Kurt Core consumers will know if they're compatible with the currently-running
 	//  API container
-	KurtosisVersion = "0.84.9"
+	KurtosisVersion = "0.84.10"
 	// !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!!
 )

api/rust/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "kurtosis-sdk"
-version = "0.84.9"
+version = "0.84.10"
 license = "BUSL-1.1"
 description = "Rust SDK for Kurtosis"
 edition = "2021"

api/typescript/package.json

@@ -1,7 +1,7 @@
 {
     "name": "kurtosis-sdk",
     "//": "NOTE: DO NOT UPDATE THIS VERSION MANUALLY - IT WILL BE UPDATED DURING THE RELEASE PROCESS!",
-    "version": "0.84.9",
+    "version": "0.84.10",
     "main": "./build/index",
     "description": "This repo contains a Typescript client for communicating with the Kurtosis Engine server, which is responsible for creating, managing and destroying Kurtosis Enclaves.",
     "types": "./build/index",

api/typescript/src/kurtosis_version/kurtosis_version.ts

@@ -1,5 +1,5 @@
 // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!!
 // This is necessary so that Kurt Core consumers (e.g. modules) will know if they're compatible with the currently-running
 //  API container
-export const KURTOSIS_VERSION: string = "0.84.9"
+export const KURTOSIS_VERSION: string = "0.84.10"
 // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!!

cli/cli/commands/package/init_cmd/init_cmd.go

@@ -8,20 +8,24 @@ import (
 	"github.com/kurtosis-tech/kurtosis/cli/cli/command_framework/lowlevel/flags"
 	"github.com/kurtosis-tech/kurtosis/cli/cli/command_str_consts"
 	"github.com/kurtosis-tech/kurtosis/cli/cli/kurtosis_package"
+	"github.com/kurtosis-tech/kurtosis/cli/cli/user_support_constants"
 	"github.com/kurtosis-tech/stacktrace"
 	"os"
 )
 
 const (
 	packageNameArgKey          = "package-name"
-	packageNameArgDefaultValue = ""
-	packageNameArgIsOptional   = false
+	packageNameArgDefaultValue = "github.com/example-org/example-package"
+	packageNameArgIsOptional   = true
 	packageNameArgIsGreedy     = false
 
-	executablePackageFlagKey          = "main"
-	executablePackageFlagDefaultValue = "false"
+	alwaysCreateExecutablePackage = true
+
+	validPackageNameExample = "github.com/kurtosis-tech/ethereum-package"
 )
 
+// InitCmd we only fill in the required struct fields, hence the others remain nil
+// nolint: exhaustruct
 var InitCmd = &lowlevel.LowlevelKurtosisCommand{
 	CommandStr:       command_str_consts.InitCmdStr,
 	ShortDescription: "Creates a new Kurtosis package",
@@ -35,14 +39,6 @@ var InitCmd = &lowlevel.LowlevelKurtosisCommand{
 			ValidationFunc: validatePackageNameArg,
 		},
 	},
-	Flags: []*flags.FlagConfig{
-		{
-			Key:     executablePackageFlagKey,
-			Usage:   "indicates that the created package is an executable package, and generates a 'main.star' if one does not already exist.",
-			Type:    flags.FlagType_Bool,
-			Default: executablePackageFlagDefaultValue,
-		},
-	},
 	PreValidationAndRunFunc:  nil,
 	RunFunc:                  run,
 	PostValidationAndRunFunc: nil,
@@ -54,17 +50,12 @@ func run(ctx context.Context, flags *flags.ParsedFlags, args *args.ParsedArgs) e
 		return stacktrace.Propagate(err, "an error occurred getting the value of argument with key '%v'", packageNameArgKey)
 	}
 
-	executablePackageFlag, err := flags.GetBool(executablePackageFlagKey)
-	if err != nil {
-		return stacktrace.Propagate(err, "an error occurred getting the value of flag '%v'", executablePackageFlagKey)
-	}
-
 	packageDestinationDirpath, err := os.Getwd()
 	if err != nil {
 		return stacktrace.Propagate(err, "An error occurred getting the current working directory for creating the Kurtosis package")
 	}
 
-	if err := kurtosis_package.InitializeKurtosisPackage(packageDestinationDirpath, packageNameArg, executablePackageFlag); err != nil {
+	if err := kurtosis_package.InitializeKurtosisPackage(packageDestinationDirpath, packageNameArg, alwaysCreateExecutablePackage); err != nil {
 		return stacktrace.Propagate(err, "An error occurred initializing the Kurtosis package '%s' in '%s'", packageNameArg, packageDestinationDirpath)
 	}
 
@@ -78,7 +69,7 @@ func validatePackageNameArg(_ context.Context, _ *flags.ParsedFlags, args *args.
 	}
 
 	if _, err := shared_utils.ParseGitURL(packageNameArg); err != nil {
-		return stacktrace.Propagate(err, "An erro occurred validating package name '%v', invalid GitHub URL", packageNameArg)
+		return stacktrace.Propagate(err, "An error occurred validating package name '%v', invalid GitHub URL, the package name has to be a valid GitHub URL like '%s'. You can see more here: '%s' ", packageNameArg, validPackageNameExample, user_support_constants.StarlarkPackagesReferenceURL)
 	}
 
 	return nil

docs/docs/cli-reference/package-init.md

@@ -10,9 +10,9 @@ The `package init` command converts the current directory into a [Kurtosis packa
 kurtosis package init $PACKAGE_NAME
 ```
 
-The optional `#PACKAGE_NAME` argument is the [locator][locators] to the package, in the format `github.com/USER/REPO`.
+The optional `$PACKAGE_NAME` argument is the [locator][locators] to the package, in the format `github.com/USER/REPO`.
 
-<!----------------------
+<!---------------------->
 [package]: ../concepts-reference/packages.md
 [kurtosis-yml]: ../concepts-reference/kurtosis-yml.md
 [locators]: ../concepts-reference/locators.md

version.txt

@@ -1 +1 @@
-0.84.9
+0.84.10