vscode-runme

Build the Runme VS Code extension end-to-end.

Installation

dagger install github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402

Entrypoint

Return Type

VscodeRunme !

Arguments

Name	Type	Default Value	Description
source	Directory	-	No description provided

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \

func (m *MyModule) Example() *dagger.VscodeRunme  {
	return dag.
			VscodeRunme()
}

@function
def example() -> dagger.VscodeRunme:
	return (
		dag.vscode_runme()
	)

@func()
example(): VscodeRunme {
	return dag
		.vscodeRunme()
}

Types

VscodeRunme 🔗

source() 🔗

The source to build the extension from.

Return Type

Directory !

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 source

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			VscodeRunme().
			Source()
}

@function
def example() -> dagger.Directory:
	return (
		dag.vscode_runme()
		.source()
	)

@func()
example(): Directory {
	return dag
		.vscodeRunme()
		.source()
}

container() 🔗

The container to build the extension in.

Return Type

Container !

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 container

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			VscodeRunme().
			Container()
}

@function
def example() -> dagger.Container:
	return (
		dag.vscode_runme()
		.container()
	)

@func()
example(): Container {
	return dag
		.vscodeRunme()
		.container()
}

extension() 🔗

The extension to perform operations on if different from the source.

Return Type

Directory !

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 extension

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			VscodeRunme().
			Extension()
}

@function
def example() -> dagger.Directory:
	return (
		dag.vscode_runme()
		.extension()
	)

@func()
example(): Directory {
	return dag
		.vscodeRunme()
		.extension()
}

presetup() 🔗

The presetup script to be added to the container.

Return Type

File !

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 presetup

func (m *MyModule) Example() *dagger.File  {
	return dag.
			VscodeRunme().
			Presetup()
}

@function
def example() -> dagger.File:
	return (
		dag.vscode_runme()
		.presetup()
	)

@func()
example(): File {
	return dag
		.vscodeRunme()
		.presetup()
}

defaultPlatform() 🔗

Get the default platform for the container.

Return Type

Scalar !

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 default-platform

func (m *MyModule) Example()   {
	return dag.
			VscodeRunme().
			DefaultPlatform()
}

@function
def example() -> :
	return (
		dag.vscode_runme()
		.default_platform()
	)

@func()
example():  {
	return dag
		.vscodeRunme()
		.defaultPlatform()
}

base() 🔗

Sets up the base container

Return Type

VscodeRunme !

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 base

func (m *MyModule) Example() *dagger.VscodeRunme  {
	return dag.
			VscodeRunme().
			Base()
}

@function
def example() -> dagger.VscodeRunme:
	return (
		dag.vscode_runme()
		.base()
	)

@func()
example(): VscodeRunme {
	return dag
		.vscodeRunme()
		.base()
}

build() 🔗

Builds the VSIX extension file.

Return Type

VscodeRunme !

Arguments

Name	Type	Default Value	Description
runmeBinary	Directory !	-	- The runme binary to be added to the container.

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 build --runme-binary DIR_PATH

func (m *MyModule) Example(runmeBinary *dagger.Directory) *dagger.VscodeRunme  {
	return dag.
			VscodeRunme().
			Build(runmeBinary)
}

@function
def example(runme_binary: dagger.Directory) -> dagger.VscodeRunme:
	return (
		dag.vscode_runme()
		.build(runme_binary)
	)

@func()
example(runmeBinary: Directory): VscodeRunme {
	return dag
		.vscodeRunme()
		.build(runmeBinary)
}

prebuild() 🔗

Return Type

VscodeRunme !

Arguments

Name	Type	Default Value	Description
extensionVsix	File !	-	No description provided

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 prebuild --extension-vsix file:path

func (m *MyModule) Example(extensionVsix *dagger.File) *dagger.VscodeRunme  {
	return dag.
			VscodeRunme().
			Prebuild(extensionVsix)
}

@function
def example(extension_vsix: dagger.File) -> dagger.VscodeRunme:
	return (
		dag.vscode_runme()
		.prebuild(extension_vsix)
	)

@func()
example(extensionVsix: File): VscodeRunme {
	return dag
		.vscodeRunme()
		.prebuild(extensionVsix)
}

bundle() 🔗

Bundles the VSIX extension file.

Return Type

File !

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 bundle

func (m *MyModule) Example() *dagger.File  {
	return dag.
			VscodeRunme().
			Bundle()
}

@function
def example() -> dagger.File:
	return (
		dag.vscode_runme()
		.bundle()
	)

@func()
example(): File {
	return dag
		.vscodeRunme()
		.bundle()
}

unitTest() 🔗

Runs the unit tests.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
debug	Boolean !	false	- Whether to run the tests in debug mode.

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 unit-test --debug boolean

func (m *MyModule) Example(debug bool) *dagger.Container  {
	return dag.
			VscodeRunme().
			UnitTest(debug)
}

@function
def example(debug: bool) -> dagger.Container:
	return (
		dag.vscode_runme()
		.unit_test(debug)
	)

@func()
example(debug: boolean): Container {
	return dag
		.vscodeRunme()
		.unitTest(debug)
}

integrationTest() 🔗

Integration tests the extension end-to-end.

Return Type

Container !

Arguments

Name	Type	Default Value	Description
runmeTestToken	Secret	-	- The Runme test token to use for integration tests.
debug	Boolean !	false	- Whether to run the tests in debug mode.
spec	String	-	- The spec file to run, omit "tests/e2e".

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 integration-test --debug boolean

func (m *MyModule) Example(debug bool) *dagger.Container  {
	return dag.
			VscodeRunme().
			IntegrationTest(debug)
}

@function
def example(debug: bool) -> dagger.Container:
	return (
		dag.vscode_runme()
		.integration_test(debug)
	)

@func()
example(debug: boolean): Container {
	return dag
		.vscodeRunme()
		.integrationTest(debug)
}

ghaJob() 🔗

Sets the GitHub Actions job info.

Return Type

VscodeRunme !

Arguments

Name	Type	Default Value	Description
actor	String !	-	- The GitHub Actions actor.
baseOwner	String !	-	- The GitHub Actions base owner.
eventName	String !	-	- The GitHub Actions event name.
forkOwner	String !	-	- The GitHub Actions fork owner.
specRetries	Integer !	5	- The number of retries for the spec.

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 gha-job --actor string --base-owner string --event-name string --fork-owner string --spec-retries integer

func (m *MyModule) Example(actor string, baseOwner string, eventName string, forkOwner string, specRetries int) *dagger.VscodeRunme  {
	return dag.
			VscodeRunme().
			GhaJob(actor, baseOwner, eventName, forkOwner, specRetries)
}

@function
def example(actor: str, base_owner: str, event_name: str, fork_owner: str, spec_retries: int) -> dagger.VscodeRunme:
	return (
		dag.vscode_runme()
		.gha_job(actor, base_owner, event_name, fork_owner, spec_retries)
	)

@func()
example(actor: string, baseOwner: string, eventName: string, forkOwner: string, specRetries: number): VscodeRunme {
	return dag
		.vscodeRunme()
		.ghaJob(actor, baseOwner, eventName, forkOwner, specRetries)
}

listRelease() 🔗

Fetches a Runme release from GitHub and returns a directory with the release assets.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
githubToken	Secret	-	Optional GitHub token for authentication
version	String !	"latest"	Release version to fetch, defaults to 'latest'

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 list-release --version string

func (m *MyModule) Example(version string) *dagger.Directory  {
	return dag.
			VscodeRunme().
			ListRelease(version)
}

@function
def example(version: str) -> dagger.Directory:
	return (
		dag.vscode_runme()
		.list_release(version)
	)

@func()
example(version: string): Directory {
	return dag
		.vscodeRunme()
		.listRelease(version)
}

linkRelease() 🔗

Fetches a Runme release from GitHub and returns a directory with the uncompressed release files.

Return Type

File !

Arguments

Name	Type	Default Value	Description
platform	String !	-	Target OS/arch in the format 'os/arch', e.g. 'linux/amd64'
githubToken	Secret	-	Optional GitHub token for authentication
version	String !	"latest"	Release version to fetch, defaults to 'latest'

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 link-release --platform string --version string

func (m *MyModule) Example(platform string, version string) *dagger.File  {
	return dag.
			VscodeRunme().
			LinkRelease(platform, version)
}

@function
def example(platform: str, version: str) -> dagger.File:
	return (
		dag.vscode_runme()
		.link_release(platform, version)
	)

@func()
example(platform: string, version: string): File {
	return dag
		.vscodeRunme()
		.linkRelease(platform, version)
}

unpackExtension() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
extensionVsix	File !	-	No description provided

Example

dagger -m github.com/runmedev/vscode-runme@bd4f5cc3f5208c5b3fd9468a226e5708f52db402 call \
 unpack-extension --extension-vsix file:path

func (m *MyModule) Example(extensionVsix *dagger.File) *dagger.Directory  {
	return dag.
			VscodeRunme().
			UnpackExtension(extensionVsix)
}

@function
def example(extension_vsix: dagger.File) -> dagger.Directory:
	return (
		dag.vscode_runme()
		.unpack_extension(extension_vsix)
	)

@func()
example(extensionVsix: File): Directory {
	return dag
		.vscodeRunme()
		.unpackExtension(extensionVsix)
}